From the BoostSRL Contributing Guidelines:
The goal in this project is to match and eventually extend beyond BoostSRL (the Java version of the codebase), contributions which further this are welcome.
Code of Conduct¶
We adopt the Contributor Covenant Code of Conduct
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at email@example.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate for the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of the incident.
Fork and clone the source from GitHub
git clone https://github.com/hayesall/rfgb.git
Building local copy of documentation
We use Sphinx autodoc with a combination of inline docstrings and reStructuredText for documenting this project. Pull requests and further updates should include appropriate documentation.
A local copy of the documentation may be built from the Makefile:
cd docs make html xdg-open build/html/index.html
Running the unit tests
rfgb/tests/contains a suite of unit tests, these can be ran via the following:
As of 0.2.0, these should be ran from the base of the repository due to their import structure.