From 45c1a7f85a5b03832ac383bb316fad9a9c313845 Mon Sep 17 00:00:00 2001 From: Isaac Milarsky Date: Tue, 11 Feb 2025 15:19:40 -0600 Subject: [PATCH] changes based on repolinter output --- CODEOWNERS.md | 17 +++++++ CODE_OF_CONDUCT.md | 10 ++++ COMMUNITY_GUIDELINES.md | 29 +++++++++++ CONTRIBUTING.md | 107 ++++++++++++++++++++++++++++++++++++++++ GOVERNANCE.md | 3 ++ MAINTAINERS.md | 20 ++++++++ README.md | 77 +++++++++++++++++++++++++++++ 7 files changed, 263 insertions(+) create mode 100644 CODEOWNERS.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 COMMUNITY_GUIDELINES.md create mode 100644 CONTRIBUTING.md create mode 100644 GOVERNANCE.md create mode 100644 MAINTAINERS.md diff --git a/CODEOWNERS.md b/CODEOWNERS.md new file mode 100644 index 0000000..03bc4ba --- /dev/null +++ b/CODEOWNERS.md @@ -0,0 +1,17 @@ +# Code Owners + + + ## Repository Domains + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..724395c --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,10 @@ +## Contributor Code of Conduct +As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. + We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity, expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion. + Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. + Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct. + Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers at opensource@cms.hhs.gov. + This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/) + + ## Acknowledgements +This CODE_OF_CONDUCT.md was originally forked from the [United States Digital Service](https://usds.gov) [Justice40](https://thejustice40.com) open source [repository](https://github.com/usds/justice40-tool), and we would like to acknowledge and thank the community for their contributions. diff --git a/COMMUNITY_GUIDELINES.md b/COMMUNITY_GUIDELINES.md new file mode 100644 index 0000000..b5afbcc --- /dev/null +++ b/COMMUNITY_GUIDELINES.md @@ -0,0 +1,29 @@ +# {name_of_project_here} Open Source Community Guidelines +This document contains principles and guidelines for participating in the {name_of_project_here} open source community. + + ## Principles +These principles guide our data, product, and process decisions, architecture, and approach. +- Open means transparent and participatory. +- We take a modular and modern approach to software development. +- We build open-source software and open-source process. +- We value ease of implementation. +- Fostering community includes building capacity and making our software and processes accessible to participants with diverse backgrounds and skillsets. +- Data (and data science) is as important as software and process. We build open data sets where possible. +- We strive for transparency for algorithms and places we might be introducing bias. + + ## Community Guidelines +All community members are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). +Information on contributing to this repository is available in our [Contributing file](CONTRIBUTING.md). +When participating in {{ cookiecutter.project_name }} open source community conversations and spaces, we ask individuals to follow the following guidelines: +- When joining a conversation for the first time, please introduce yourself by providing a brief intro that includes: + - your related organization (if applicable) + - your pronouns + - your superpower, and how you hope to use it for {{ cookiecutter.project_name }} +- Embrace a culture of learning, and educate each other. We are all entering this conversation from different starting points and with different backgrounds. There are no dumb questions. +- Take space and give space. We strive to create an equitable environment in which all are welcome and able to participate. We hope individuals feel comfortable voicing their opinions and providing contributions and will do our best to recognize and make space for individuals who may be struggling to find space here. Likewise, we expect individuals to recognize when they are taking up significant space and take a step back to allow room for others. + +- Be respectful. +- Default to positive. Assume others' contributions are legitimate and valuable and that they are made with good intention. + + ## Acknowledgements +This COMMUNITY_GUIDELINES.md was originally forked from the [United States Digital Service](https://usds.gov) [Justice40](https://thejustice40.com) open source [repository](https://github.com/usds/justice40-tool), and we would like to acknowledge and thank the community for their contributions. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..410a717 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,107 @@ +# Contributing Guidelines + + + We're so thankful you're considering contributing to an [open source project of the U.S. government](https://code.gov/)! If you're unsure about anything, just ask -- or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We appreciate all friendly contributions. + + We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md). + + ## Getting Started + + + ### Team Specific Guidelines + + + ### Building Dependencies + + + ### Building the Project + + + ### Workflow and Branching + + + ### Testing Conventions + + + ### Coding Style and Linters + + + ### Writing Issues + + + ### Writing Pull Requests + + + ### Reviewing Pull Requests + + + ## Shipping Releases + + + ## Documentation + + + ## Policies + + ### Open Source Policy +We adhere to the [CMS Open Source Policy](https://github.com/CMSGov/cms-open-source-policy). If you have any questions, just [shoot us an email](mailto:opensource@cms.hhs.gov). + + ### Security and Responsible Disclosure Policy +*Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days. + For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md). + + ## 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/) as indicated in [LICENSE](LICENSE). + All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest. diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 0000000..59d2bad --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,3 @@ +# Governance + + This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 0000000..83ccc16 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,20 @@ +## Maintainers + + This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS.md) for list of reviewers for different parts of the codebase. Team members include: + + ## Maintainers List: + + - + + ## Approvers: + - + + ## Reviewers: + - + +| Roles | Responsibilities | Requirements | Defined by | +| -------------|:-----------------------------------------|:-----------------------------------------------|:---------------------------------------| +| member | active contributor in the community | multiple contributions to the project. | PROJECT GitHub org Committer Team | +| reviewer | review contributions from other members | history of review and authorship in a sub-project | MAINTAINERS file reviewer entry, and GitHub Org Triage Team | +| approver | approve accepting contributions | highly experienced and active reviewer + contributor to a sub-project | MAINTAINERS file approver entry and GitHub Triage Team | +| lead | set direction and priorities for a sub-project | demonstrated responsibility and excellent technical judgement for the sub-project | MAINTAINERS file owner entry and GitHub Org Admin Team | diff --git a/README.md b/README.md index cb338d2..98a24e0 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,80 @@ npm start ``` [pat]: (https://github.com/settings/tokens) + + ## About the Project + + + ## Core Team +An up-to-date list of core team members can be found in [MAINTAINERS.md](MAINTAINERS.md). At this time, the project is still building the core team and defining roles and responsibilities. We are eagerly seeking individuals who would like to join the community and help us define and fill these roles. + + ## Documentation Index + + **{list of .md at top directory and descriptions}** + + ## Repository Structure + + + **{list directories and descriptions}** + + ## Development and Software Delivery Lifecycle +The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md). + + ## Local Development + + + ## Coding Style and Linters + + Each application has its own linting and testing guidelines. Lint and code tests are run on each commit, so linters and tests should be run locally before commiting. + + ## Branching Model + + + ## Contributing +Thank you for considering contributing to an Open Source project of the US Government! For more information about our contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md). + + ## Codeowners +The contents of this repository are managed by **{responsible organization(s)}**. Those responsible for the code and documentation in this repository can be found in [CODEOWNERS.md](CODEOWNERS.md). + + ## Community +The {name_of_project_here} 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 technology, or who have experience with similar technologies deployed in other spaces. 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, and offer support to community members with a wide variety of backgrounds and skillsets. + + ## Community Guidelines +Principles and guidelines for participating in our open source community are can be found in [COMMUNITY_GUIDELINES.md](COMMUNITY_GUIDELINES.md). Please read them before joining or starting a conversation in this repo or one of the channels listed below. All community members and participants are expected to adhere to the community guidelines and code of conduct when participating in community spaces including: code repositories, communication channels and venues, and events. + + ## Feedback +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 at **{contact_email}**. If you would like to comment on the tool itself, please let us know by filing an **issue on our GitHub repository.** + + ## Policies + + ### Open Source Policy +We adhere to the [CMS Open Source Policy](https://github.com/CMSGov/cms-open-source-policy). If you have any questions, just [shoot us an email](mailto:opensource@cms.hhs.gov). + + ### Security and Responsible Disclosure Policy +*Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days. +For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md). + + ## 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/) as indicated in [LICENSE](LICENSE). +All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest. + + ### Software Bill of Materials (SBOM) +A Software Bill of Materials (SBOM) is a formal record containing the details and supply chain relationships of various components used in building software. +In the spirit of [Executive Order 14028 - Improving the Nation's Cyber Security](https://www.gsa.gov/technology/it-contract-vehicles-and-purchasing-programs/information-technology-category/it-security/executive-order-14028), a SBOM for this repository is provided here: https://github.com/{repo_org}/{repo_name}/network/dependencies. +For more information and resources about SBOMs, visit: https://www.cisa.gov/sbom. \ No newline at end of file