Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (27 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 1.41 KB

How to Contribute to GSTools

We are happy about all contributions! 👍

Did you find a bug?

  • Ensure that the bug was not already reported under GitHub issues
  • If the bug wasn't already reported, open a new issue with a clear description of the problem and if possible with a minimal working example.
  • please add the version number to the issue:
import gstools
print(gstools.__version__)

Do you have suggestions for new features?

Open a new issue with your idea or suggestion and we'd love to discuss about it.

Do you want to enhance GSTools or fix something?

  • Fork the repo on GitHub
  • Add yourself to AUTHORS.md (if you want to).
  • We use Ruff to check and format the code. Please use the scripts ruff check src/gstools and ruff format --diff src/gstools/ after you have written your code.
  • Add some tests if possible.
  • Add an example showing your new feature in one of the examples sub-folders if possible. Follow this Sphinx-Gallary guide.
  • Push to your fork and submit a pull request.