How to contribute

Did you find a bug?

Ensure the bug was not already reported by searching on GitHub under Issues.
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

Open a new GitHub pull request with the patch.
Ensure the pull request description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

Create a new issue suggesting your change. On your issue, please include a reproducible case that we can actually run.
After you have collected some positive feedback about the change you should start writing code and when your code is ready submit a pull request.

Do you have questions about the source code?

Ask any question as a new issue.

Do you want to contribute to the documentation?

Edit the files here and send a pull request with your changes.

Thanks! ❤️ ❤️ ❤️

The Software Sustainability Institute Team