c3a68cb251
* Update code owners to include new folks and remove the departed ones * Update maintainers to reflect the current personnel * Update contributing with the latest, and make small changes to readme to make it easier to read * Update maintainers with Lucas Brown * Update installation guide to refine instructions and make them easier to follow * Try emojis to make notes stand out more * Experiment with note * Moved installation of data pipeline into a new file (contents TBD), and redid most part of the data pipeline README for clarity and readability * Add mermaid diagram * Fix table * Update readme for clarity and correctness * Update TOC * Fix comparator doc * Add section on internal score comparison * Move tox information from installation to testing * Update installation for data pipeline * Add emojis to make picking out platform-specific instructions easier * Fix Git caps * Update for readability * Add direct link to VS Code instructions * Fix broken link and improve readability * Update installation for clarity and proper case * Update python text * Clean up information about poetry and poetry lockfiles * Remove duplicate paragraph * Fix case * update date table * re-adjust table to put links at the end * Fix a few minor typos --------- Co-authored-by: Sam Powers <121890478+sampowers-usds@users.noreply.github.com>
3.9 KiB
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 Climate and Economic Justice Screening Tool (CEJST) that lives in this repository.
Before contributing, we encourage you to read our LICENSE and README files. If you have any questions not answered by the content of this repository, please contact us.
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.
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.
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 for any similar bugs. If you find a similar bug, please update that issue with your details.
If you do not find your bug in our issues list, file a bug report. When reporting the bug, please follow these guidelines:
- Please use the
Bug Reportissue template (here). 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 to reproduce the problem in as much detail 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.
Please open an issue of type Feature request here.
In this 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 Feature request as soon as possible.
Contribute to the Code
If you would like to contribute to any part of the codebase, please fork the repository following the Github forking methodology. Make changes to the code in your own copy of the repository – including tests if applicable – and submit a pull request against the upstream repo. In order for us to merge a pull request, the following checks are enabled within this repo:
- Merges to
mainare prohibited - please open a pull request from a branch - Please create a branch name in the format of
<github-username>/<issue-number>-<kebab-case-description>. For example vimusds/1069-fix-territory-on-mobile - At least one required reviewer must approve the commit (see 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.