mirror of
https://github.com/DOI-DO/j40-cejst-2.git
synced 2025-02-22 01:31:25 -08:00
Add contribution info and license
* Uses CDCGov projects like PRIME as well as Atom and 18f github orgs for inspiration * Does not have a CoC yet (need more research here) * Could use some more details fleshed out on how to contribute code and what that process is, but this warrents some more discussion
This commit is contained in:
parent
ab6b57271b
commit
6217b2acf0
3 changed files with 75 additions and 2 deletions
34
CONTRIBUTING.md
Normal file
34
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,34 @@
|
|||
# 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.
|
||||
|
||||
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.
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
### 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.
|
||||
|
||||
### 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.
|
25
LICENSE
Normal file
25
LICENSE
Normal file
|
@ -0,0 +1,25 @@
|
|||
## This project is in the worldwide public domain
|
||||
|
||||
As a work of the United States government, this project is in the public domain within the United States.
|
||||
|
||||
Additionally, we waive copyright and related rights in the work worldwide through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
|
||||
|
||||
### CC0 1.0 Universal Summary
|
||||
|
||||
This is a human-readable summary of the [Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
|
||||
|
||||
#### No Copyright
|
||||
|
||||
The person who associated a work with this deed has dedicated the work to the public domain by waiving all of his, her, or their rights to the work worldwide under copyright law, including all related and neighboring rights, to the extent allowed by law.
|
||||
|
||||
You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission.
|
||||
|
||||
#### Other Information
|
||||
|
||||
In no way are the patent or trademark rights of any person affected by CC0, nor are the rights that other persons may have in the work or in how the work is used, such as publicity or privacy rights.
|
||||
|
||||
Unless expressly stated otherwise, the person who associated a work with this deed makes no warranties about the work, and disclaims liability for all uses of the work, to the fullest extent permitted by applicable law. When using or citing the work, you should not imply endorsement by the author or the affirmer.
|
||||
|
||||
### Contributions to this project
|
||||
|
||||
As stated in [CONTRIBUTING](CONTRIBUTING.md), 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.
|
18
README.md
18
README.md
|
@ -1,3 +1,17 @@
|
|||
# Justice 40 Tool
|
||||
|
||||
The home of the Justice40 Tool.
|
||||
# Justice40 Tool
|
||||
[](https://github.com/usds/justice40-tool/blob/main/LICENSE)
|
||||
|
||||
This repo contains the code for the working prototype and soon to be MVP of the Justice40 Climate, Environmental, and Economic Justice Screeing Tool. The Justice40 initiative and screening tool were announced in an [Executive Order](https://www.whitehouse.gov/briefing-room/presidential-actions/2021/01/27/executive-order-on-tackling-the-climate-crisis-at-home-and-abroad/) in January 2021, with the goal to launch an MVP of the tool by July 27, 2021. This tool will include interactive maps and an initial draft scorecard by which federal agencies can identify historically overburdened and underserved communities for benefits in their programs.
|
||||
|
||||
The Justice40 team is taking a community-first and open source approach to the product development of this tool. We encourage contributions in the form of discussion on issues in this repo and pull requests of documentation and code. Please see the [Contributing](#Contributing) section for more information.
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are always welcome!
|
||||
|
||||
See `CONTRIBUTING.md` for ways to get started.
|
||||
|
||||
## Feedback
|
||||
|
||||
If you have any feedback or questions, please reach out to us at justice40open@usds.gov.
|
||||
|
|
Loading…
Add table
Reference in a new issue