Contributions are welcomed via pull requests on GitHub. Contact the GSD developers before starting work to ensure it meshes well with the planned development direction and standards set for the project.
New features should be applicable to a variety of use-cases. The GSD developers can assist you in designing flexible interfaces.
Expensive code paths should only execute when requested.
- Base backwards compatible bug fixes on
trunk-patch. - Base additional functionality on
trunk-minor. - Base API incompatible changes on
trunk-major.
All changes in a pull request should be closely related. Multiple change sets that are loosely coupled should be proposed in separate pull requests.
All contributors must agree to the Contributor Agreement before their pull request can be merged.
Git identifies every commit you make with your name and e-mail. Set your identity to correctly identify your work and set it identically on all systems and accounts where you make commits.
The Code style section of the documentation sets the style guidelines for GSD code.
Use doxygen header comments for classes, functions, etc. Also comment complex sections of code so that other developers can understand them.
Your changes should compile without warnings.
Add unit tests for all new functionality.
The developer should run research-scale simulations using the new functionality and ensure that it behaves as intended.
Document public-facing API with Python docstrings in Google style.
Demonstrate new functionality in the documentation examples pages.
Each user-facing Python class, method, etc. with a docstring should have [versionadded,
versionchanged, and deprecated Sphinx directives]
Update the credits documentation to name each developer that has contributed to the code.
Propose a short concise entry describing the change in the pull request description.