Contributions are welcomed via pull requests. Contact the HOOMD-blue 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 HOOMD-blue developers can assist you in designing flexible interfaces.
All new work should be based on trunk
.
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.
Follow the HOOMD-blue style guide.
Use python docstrings for classes, functions, attributes, modules, and packages. Also comment complex sections of code so that other developers can understand them.
Document public-facing API with Python docstrings in Google style.
List contributing developers in CONTRIBUTORS.md.