We welcome contributions in the form of bug reports, bug fixes, improvements to the documentation, ideas for enhancements, or the enhancements themselves!
You can find a list of current issues in the project's GitHub repository. Feel free to tackle any existing bugs or enhancement ideas by submitting a pull request. Some issues may be marked as beginner-friendly. These issues are a great place to start working with mr_sim, if you're new here.
- Please include a short (but detailed) code snippet or explanation for reproducing the problem. Attach or include a link to any input files that will be needed to reproduce the error.
- Explain the behavior you expected, and how what you got differed.
- Include the full text of any error messages.
- Make sure the test suite passes on your computer. To do this, run
make test. - Always add tests and docs for your code.
- Please reference relevant GitHub issues in your commit messages (for example
#123). - Changes should be formatted with the black code formatter.
- Keep style fixes to a separate commit to make your pull request more readable.
- Docstrings should follow the Google style.
- When you start working on a pull request, start by creating a new branch pointing at the latest commit on GitHub master.
- The copyright policy is detailed in the
LICENSE.
Thanks to the useful contributing guide of thermostate, which served as an inspiration and starting point for this guide.