Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 3.81 KB

CONTRIBUTING.md

File metadata and controls

52 lines (33 loc) · 3.81 KB
Raw

Contributing to the Justice40 Tool

¡Lea esto en español!

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

Before contributing, we encourage you to also read our LICENSE and 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.

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 in case a similar issue has already been opened.

When reporting the bug, please follow these guidelines:

  • Please use the Bug Report issue 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 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.

Please open an issue of type "Feature request" here.

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.

Code contributions

If you would like to contribute to any part of the codebase, please fork the repository following the Github forking methodology. Then, make changes to the code in your own copy of the repository, including tests if applicable, and finally 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 main are 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.