publicdata/j40-cejst-2
1
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-02-22 01:31:25 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

updating CONTRIBUTING

Browse source
This commit is contained in:
Nat Hillard 2021-05-06 15:00:46 -04:00
parent 3805e63178
commit d890ff64ca
1 changed files with 24 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
CONTRIBUTING.md
View file

@ -1,4 +1,5 @@
# Contributing to the Justice40 Tool
🎉 First off, thanks for taking the time to contribute! 🎉
The following is a set of guidelines for contributing to the Justice40 Tool that lives in this repository.
@ -6,6 +7,7 @@ The following is a set of guidelines for contributing to the Justice40 Tool that
Before contributing, we encourage you to also read our [LICENSE](https://github.com/usds/justice40-tool/blob/main/LICENSE) and [README](https://github.com/usds/justice40-tool/blob/main/README) files, also found in this repository. If you have any questions not answered by the content of this repository, please don't hesitate to [contact us](mailto:justice40open@usds.gov).
## Public Domain
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
All contributions to this project will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.
@ -13,22 +15,34 @@ All contributions to this project will be released under the CC0 dedication. By
## How Can I Contribute?
### Report a bug
If you think you have found a bug in the Justice40 tool, search our issues list on GitHub in case a similar issue has already been opened.
When reporting the bug, please follow these guidelines:
* **Use a clear and descriptive issue title** for the issue to identify the problem.
* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you got to the page where you encountered the bug.
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
* **Explain which behavior you expected to see instead and why.**
* **Include screenshots and animated GIFs** if possible, which show you following the described steps and clearly demonstrate the problem.
* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened.
- **Please use the `Bug Report` issue template** ([here](https://github.com/usds/justice40-tool/issues/new/choose)). This is populated with the right information
- **Use a clear and descriptive issue title** for the issue to identify the problem.
- **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you got to the page where you encountered the bug.
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
- **Explain which behavior you expected to see instead and why.**
- **Include screenshots and animated GIFs** if possible, which show you following the described steps and clearly demonstrate the problem.
- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened.
### Suggest an enhancement
If you don't have specific language or code to submit but would like to suggest a change, request a feature,
or have something addressed, you can open an issue in this repository. In the issue please describe the feature you would like to see, why you need it, and how it should work. Team members will respond to the issue as soon as possible.
or have something addressed, you can open an issue in this repository.
Please open an issue of type "Feature request" [here](https://github.com/usds/justice40-tool/issues/new/choose).
In the issue, please describe the feature you would like to see, why you need it, and how it should work. Team members will respond to the issue as soon as possible.
### Submit a pull request
If you would like to contribute, please submit a pull request. In order for us to merge a pull request, it must:
* Receive a +1 from a majority of team members associated with the request. If there is significant dissent between the team, a meeting will be held to discuss a plan of action for the pull request.
If you would like to contribute, please submit a pull request. In order for us to merge a pull request, the following checks are enabled within this repo:
- Merges to `main` are prohitited - please open a pull request from a branch
- At least one required reviewer must approve the commit (see [CODEOWNERS](https://github.com/usds/justice40-tool/tree/main/.github/CODEOWNERS) for the most up-to-date list of these members)
- All required status checks must pass
If there is significant dissent within the team, a meeting will be held to discuss a plan of action for the pull request.