Skip to content

Latest commit

Β 

History

History
47 lines (36 loc) Β· 2.3 KB

File metadata and controls

47 lines (36 loc) Β· 2.3 KB

Contributing Guidelines

πŸŽ‰ First off, thank you for considering contributing to our project! πŸŽ‰

This is a community-driven project, so it's people like you that make it useful and successful. These are some of the many ways to contribute:

  • πŸ› Submitting bug reports and feature requests
  • πŸ“ Writing tutorials or examples
  • πŸ” Fixing typos and improving the documentation
  • πŸ’‘ Writing code for everyone to use
  • πŸ§‘β€πŸ€β€πŸ§‘ Community engagement and outreach

If you get stuck at any point you can create an issue on GitHub or contact us at one of the channels mentioned in the Contributing Guide.

For more information on contributing to open source projects, GitHub's own guide is a great starting point if you are new to version control. Also, check out the Zen of Scientific Software Maintenance for some guiding principles on how to create high quality scientific software contributions.

Ground Rules

The goal is to maintain a diverse community that's pleasant for everyone. Please be considerate and respectful of others. Everyone must abide by our Code of Conduct and we encourage all to read it carefully.

First-Time Contributors

We welcome first-time contributors! If you are new to open source, we recommend starting with a small contribution, such as fixing a typo or adding a simple example. We hope that the contributing process will be a good experience for you. Please let us know if there is any way that it could be improved. After your PR is merged, feel free to open a new pull request to add yourself to the AUTHORS.md file.

Quick links