CONTRIBUTING.md

How to contribute to Zooniverse Project Builder (Panoptes) API

Did you find a bug?

• Do not open up a GitHub issue if the bug is a security vulnerability in Panoptes, and instead to refer to our security policy.

• 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.

• For more detailed information on submitting a bug report and creating an issue, use the Rails bug reporting guidelines reporting guidelines.

Did you write a patch that fixes a bug?

• Open a new GitHub pull request with the patch.

• Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

All changes are welcome but cosmetic changes may not be reviewed as quickly.

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

• Suggest your change first using to ensure there is a good chance of it being accepted.

• Some changes may not be accepted until you have collected positive feedback about the change.

Do you have questions about the source code?

• Ask any question about how to use Panoptes via GitHub issues.

Do you want to contribute to the documentation?

• The documentation is located in the file apiary.apib using the Apiary format.

Do you want to contribute to the codebase?

• Please read the Development Guide to get started with running specs and some details on the components being used.

Panoptes is a Zooniverse led effort and we code in the open. We encourage you to pitch in and join the team!

Thanks! ❤️ ❤️ ❤️

Zooniverse Team