-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md * Delete .github/workflows/markdown-link-check.yml * Update README.md
- Loading branch information
1 parent
8712ff5
commit 23ada88
Showing
2 changed files
with
5 additions
and
60 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,21 @@ | ||
| # Justice40 Tool | ||
| # The Climate and Economic Justice Screening Tool (version 1.0) | ||
|
|
||
| [](https://github.com/usds/justice40-tool/blob/main/LICENSE.md) | ||
|
|
||
| _[¡Lea esto en español!](README-es.md)_ | ||
|
|
||
| Welcome to the Justice40 Open Source Community! This repo contains the code, processes, and documentation for the data and tech powering the Justice40 [Climate and Economic Justice Screening Tool (CEJST)](https://screeningtool.geoplatform.gov). | ||
| This repo contains the code, processes, and documentation for the data and tech powering the **version 1.0** of the [Climate and Economic Justice Screening Tool (CEJST)](https://screeningtool.geoplatform.gov). The latest version of the tool has moved to [DOI](https://github.com/DOI-DO/j40-cejst-2). | ||
|
|
||
| ## Background | ||
|
|
||
| The Justice40 initiative and CEJST were announced in the [Executive Order on Tackling the Climate Crisis at Home and Abroad](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. The CEJST includes interactive maps and an initial draft scorecard which federal agencies can use to prioritize historically overburdened and underserved communities for benefits in their programs. | ||
| The Justice40 initiative and CEJST were announced in the [Executive Order on Tackling the Climate Crisis at Home and Abroad](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. The CEJST includes interactive maps and federal agencies can use the tool to prioritize overburdened and underserved communities for benefits in their covered programs. | ||
|
|
||
| Please visit our [Open Source Community Orientation](docs/Justice40_Open_Source_Community_Orientation.pptx) deck for more information on the Justice40 initiative, our team, this project, and ways to participate. | ||
|
|
||
| ## Core Team | ||
|
|
||
| The core Justice40 team building this tool is a small group of designers, developers, and product managers from the [US Digital Service](https://www.usds.gov) in partnership with the [Council on Environmental Quality (CEQ)](https://www.whitehouse.gov/ceq/). | ||
| The initial versions of this tool were developed by [US Digital Service](https://www.usds.gov) in partnership with the [Council on Environmental Quality (CEQ)](https://www.whitehouse.gov/ceq/). | ||
|
|
||
| An up-to-date list of core team members can be found in [MAINTAINERS.md](MAINTAINERS.md). The engineering members of the core team who maintain the code in this repo are listed in [.github/CODEOWNERS](.github/CODEOWNERS). | ||
| ## Please visit the latest version of the tool at [DOI](https://github.com/DOI-DO/j40-cejst-2) | ||
|
|
||
| ## Community | ||
|
|
||
| The Justice40 team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will. | ||
|
|
||
| We know that we can learn from a wide variety of communities, including those who will use or will be impacted by the tool, who are experts in data science or technology, or who have experience in climate, economic, or environmental justice work. We are dedicated to creating forums for continuous conversation and feedback to help shape the design and development of the tool. | ||
|
|
||
| We also recognize capacity building as a key part of involving a diverse open source community. We are doing our best to use accessible language, provide technical and process documents in multiple languages, and offer support – both directly and in the form of group chats and training – to community members with a wide variety of backgrounds and skillsets. If you have ideas for how we can improve or add to our capacity building efforts and methods for welcoming people into our community, please let us know in the [Google Group](https://groups.google.com/u/4/g/justice40-open-source) or email us at [email protected]. | ||
|
|
||
| ### Community Guidelines | ||
|
|
||
| Principles and guidelines for participating in our open source community are available [here](COMMUNITY_GUIDELINES.md). Please read them before joining or starting a conversation in this repo or one of the channels listed below. | ||
|
|
||
| ### Google Group | ||
|
|
||
| Our [Google Group](https://groups.google.com/u/4/g/justice40-open-source) is open to anyone to join and share their knowledge or experiences, as well as to ask questions of the core Justice40 team or the wider community. | ||
|
|
||
| The core team uses the group to post updates on the program and tech/data issues, and to share the agenda and call for community participation in the community chat. | ||
|
|
||
| Curious about whether to ask a question here as a Github issue or in the Google Group? Github issues are for actionable topics related to the tool or data itself (e.g. questions about a specific data set in use, or suggestion for a new tool feature), and the Google Group is for general topics or questions. If you can't decide where your question fits, use the Google Group and we'll discuss it there before moving to Github if appropriate! | ||
|
|
||
| ### Open Source Community Chats | ||
|
|
||
| We host open source community chats every third Monday of the month at 5-6pm ET. You can find information about the agenda and how to participate in our [Google Group](https://groups.google.com/u/4/g/justice40-open-source). | ||
|
|
||
| Community members are welcome to use our Google Group to share updates or propose topics for discussion in community chats. | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions are always welcome! We encourage contributions in the form of discussion on issues in this repo and pull requests of documentation and code. | ||
|
|
||
| Visit [CONTRIBUTING.md](CONTRIBUTING.md) for ways to get started. | ||
|
|
||
| ## For Developers and Data Scientists | ||
|
|
||
| ### Datasets | ||
|
|
||
| The intermediate steps of the data pipeline, the scores, and the final output that is consumed by the frontend are all public and can be accessed directly. Visit [DATASETS.md](DATASETS.md) for these direct download links. | ||
|
|
||
| ### Local Quickstart | ||
|
|
||
|
|
@@ -64,7 +25,6 @@ If you want to run the entire application locally, visit [QUICKSTART.md](QUICKST | |
|
|
||
| If you have software experience or more specific use cases, in-depth documentation of how to work with this project can be found in [INSTALLATION.md](INSTALLATION.md). | ||
|
|
||
| ### Project Documentation | ||
|
|
||
| For more general documentation on the project that is not related to getting set up, including architecture diagrams and engineering decision logs, visit [docs/](docs/). | ||
|
|
||
|
|
||