perseuspy follows the standard github workflow.
- Fork the repository
- Make changes to your code
- Make a pull request
Every pull request is checked by the continuous integration system. Pull requests generally only be merged if they can be build without errors, and all unit tests pass. Additionally, if the API/documentation was changed. The apidoc documentation has to be updated.
- Declare requirements in setup.py.
- Test your code and verify correctness by running python setup.py test.
- Generate the documentation.
All public functions and modules should be documented with docstrings """docstring""" in sphinx syntax.