[x] Run make format and make check to make sure the code follows the style guide.
[n/a] Add tests for new features or tests that would have caught the bug that you're fixing.
[n/a] Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
[n/a] Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
[n/a] If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
[x] Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.
Authorship Guidelines: Our rules for giving you credit for your contributions, including authorship on publications and Zenodo archives.
Contributing Guide: What the review process is like and our infrastructure for testing and documentation.
Code of Conduct: How we expect people to interact in our projects.
A few things to keep in mind:
Remember to run make format to make sure your code follows our style guide.
If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
No matter what, we are really grateful that you put in the effort to do this! ⭐
(First step before adding 3.10: https://github.com/fatiando/boule/issues/85.)
Reminders:
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
and the base__init__.py
file for the package.AUTHORS.md
file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.