|
| 1 | +# Contribution Guidelines |
| 2 | +This is a community-driven, open source project that welcomes all contributions. Whether you're a seasoned contributor or new to the project, we're grateful for all contributions. |
| 3 | + |
| 4 | +## Community standards |
| 5 | + |
| 6 | +We are an inclusive community that values open dialogue, mutual respect, and fair treatment. Every submission will be treated equally and we encourage those with diverse backgrounds and perspectives to contribute. |
| 7 | + |
| 8 | +We are part of the University of Massachusetts Amherst, so we adhere to the [UMass Code of Student Conduct](https://www.umass.edu/dean_students/codeofconduct). |
| 9 | + |
| 10 | +## Getting started |
| 11 | +Before contributing to the project, take a look at the README file, which contains information about system requirements, environment setup steps, and a project summary. |
| 12 | + |
| 13 | +Further documentation for this project is found in the docs folder. |
| 14 | + |
| 15 | +## Selecting an issue |
| 16 | +Issues that are open for contribution are given the following labels: |
| 17 | +- good-first-issue |
| 18 | + - Issues with this tag are suited for those that do not have previous experience with the project. |
| 19 | +- help-wanted |
| 20 | + - Issues with this tag are open for contribution and are suited for those with experience in contribution. |
| 21 | + |
| 22 | +## Submitting contributions |
| 23 | + |
| 24 | +To contribute to the project, do the following: |
| 25 | +- [Fork and clone](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository |
| 26 | +- Create a [branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) for your issue |
| 27 | +- Make a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to the main branch of the upstream repository |
| 28 | + - Title your pull request with the issue you fixed |
| 29 | + - For example, "Fixed upload error to resolve Issue #987" |
| 30 | + - Include a short description of the changes you made |
| 31 | + |
| 32 | +## Issue reporting and help |
| 33 | +Report bugs, issues, or suggested features to * insert email.* |
| 34 | + |
| 35 | +Direct all questions to *insert email *, but keep in mind that we are a small team and may take awhile to respond. |
| 36 | + |
| 37 | + |
| 38 | + |
0 commit comments