Merge pull request #226 from DSACMS/repolinter-results-#18

Repolinter Results

CODEOWNERS.md

@@ -3,8 +3,16 @@
 [@decause-gov](https://github.com/decause-gov)
 [@natalialuzuriaga](https://github.com/natalialuzuriaga)
 [@IsaacMilarky](https://github.com/IsaacMilarky)
+[@sachin-panayil](https://github.com/sachin-panayil)
+[@DinneK](https://github.com/DinneK)
 
-# Shoutouts
+## Repository Domains
+
+- Repository Templates in `/tier*/` [@natalialuzuriaga](https://github.com/natalialuzuriaga) [@sachin-panayil](https://github.com/sachin-panayil) [@IsaacMilarky](https://github.com/IsaacMilarky)
+- Outbound Checklists in `/tier*/checklist.md` [@natalialuzuriaga](https://github.com/natalialuzuriaga)
+- GitHub Actions in `/.github` [@sachin-panayil](https://github.com/sachin-panayil) [@IsaacMilarky](https://github.com/IsaacMilarky) [@natalialuzuriaga](https://github.com/natalialuzuriaga)
+
+## Shoutouts
 
 [@usdigitalresponse](https://github.com/usdigitalresponse)
 
@@ -14,6 +22,12 @@
 
 Thank you [US Digital Response](https://www.usdigitalresponse.org/) Team for your support creating this repository!
 
+[Coding It Forward Fellows](https://codingitforward.com/fellowship)
+
+- [@Firebird1029](https://github.com/Firebird1029)
+- [@CreativeNick](https://github.com/CreativeNick)
+- [@RicardoZamora01](https://github.com/RicardoZamora01)
+
 # Questions?
 
 Email [email protected]

CODE_OF_CONDUCT.md

@@ -0,0 +1,17 @@
+## 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 [email protected].
+
+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.

COMMUNITY_GUIDELINES.md

@@ -0,0 +1,37 @@
+# repo-scaffolder Open Source Community Guidelines
+
+This document contains principles and guidelines for participating in the repo-scaffolder 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 the repo-scaffolder 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.
+<!-- TODO: Add if your repo has a community chat - Be present when joining synchronous conversations such as our community chat. Why be here if you're not going to *be here*? -->
+- 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.

CONTRIBUTING.md

@@ -1,5 +1,3 @@
-<!--- # NOTE: Modify sections marked with `TODO` and then rename the file.-->
-
 # How to Contribute
 
 We're so thankful you're considering contributing to an [open source project of
@@ -13,16 +11,36 @@ We encourage you to read this project's CONTRIBUTING policy (you are here), its
 
 ## Getting Started
 
-<!--- ### TODO: If you have 'good-first-issue' or 'easy' labels for newcomers, mention them here.-->
+First, install the required dependencies.
+
+To create a new repository using repo-scaffolder, run the production version of repo-scaffolder. Subsitute `X` with the tier number you'd like to create in the directory flag.
+
+```
+cookiecutter https://github.com/DSACMS/repo-scaffolder --directory=tierX
+```
+
+More commands on using repo-scaffolder for repository creation and maintenance can be found here: https://github.com/DSACMS/repo-scaffolder/blob/main/README.md#Using-repo-scaffolder
+
+### Team Specific Guidelines
+
+- Please try to keep pull requests to a reasonable size; try to split large contributions to multiple PRs
+- Please create pull requests into dev unless the contribution is some kind of bugfix or urgent hotfix.
+- Document and explain the contribution clearly according to provided standards when possible.
+- Feel free to reach out to us if there is any confusion. A list of the project maintainers is found here: [MAINTAINERS.md](./MAINTAINERS.md)
 
 ### Building dependencies
 
-In the root directory of the project,
-`pip install -r requirements.txt`
+1. Clone the repo
+
+   `git clone https://github.com/DSACMS/metrics.git`
+
+2. Install the required packages in requirements.txt
+
+   `pip install -r requirements.txt`
 
 ### Building the Project
 
-<!--- ### TODO -->
+N/A
 
 ### Workflow and Branching
 
@@ -37,13 +55,17 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
 7.  Wait for your change to be pulled into `cmsgov/cmsgov-example-repo/main`
 8.  Delete your feature branch
 
+### Testing Conventions
+
+<!--- TODO: Currently, does not have tests. Write tests then discuss where tests can be found, how they are run, and what kind of tests/coverage strategy and goals the project has. -->
+
 ### Coding Style and Linters
 
-This project strives to adhere to the Python Style Guide (http://peps.python.org/pep-0008/). We would recommend using a linter such as pyflakes, flake8, black, or other plugin for your editor or IDE of choice.
+<!-- TODO - Add the repo's linting and code style guidelines -->
 
--->
+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.
 
-### Issues
+### Writing Issues
 
 When creating an issue please try to adhere to the following format:
 
@@ -63,7 +85,7 @@ When creating an issue please try to adhere to the following format:
 
     see our .github/ISSUE_TEMPLATE.md for more examples.
 
-### Pull Requests
+### Writing Pull Requests
 
 Comments should be formatted to a width no greater than 80 columns.
 
@@ -107,7 +129,7 @@ a development branch for additional testing. Once the changes are merged, they w
 be pushed back to the main branch.
 
 If the issue the pull request is addressing is particularly urgent, the pull request
-will be merged directly into the main branch. 
+will be merged directly into the main branch.
 
 ## Documentation
 
@@ -124,7 +146,7 @@ questions, just [shoot us an email](mailto:[email protected]).
 
 ### 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.
+_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).
 

GOVERNANCE.md

@@ -0,0 +1,5 @@
+# Governance
+
+<!-- TODO: Starting at Tier 3 GOVERNANCE.md has basic language about early community governance, how the project make decisions, and how contributors are elevated through the leadership process if any (e.g. joining teams, getting maintainer status, etc...)-->
+
+This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md).

MAINTAINERS.md

@@ -0,0 +1,38 @@
+## Maintainers
+
+<!-- TODO: Who are the points of contact in your project who are responsible/accountable for the project? This can often be an engineering or design manager or leader, who may or may not be the primary maintainers of the project. -->
+
+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:
+
+- [@decause-gov](https://github.com/decause-gov)
+- [@natalialuzuriaga](https://github.com/natalialuzuriaga)
+- [@IsaacMilarky](https://github.com/IsaacMilarky)
+- [@sachin-panayil](https://github.com/sachin-panayil)
+- [@DinneK](https://github.com/DinneK)
+
+## Approvers:
+
+- [@decause-gov](https://github.com/decause-gov)
+
+## Reviewers:
+
+- [@natalialuzuriaga](https://github.com/natalialuzuriaga)
+- [@IsaacMilarky](https://github.com/IsaacMilarky)
+- [@sachin-panayil](https://github.com/sachin-panayil)
+- [@DinneK](https://github.com/DinneK)
+
+| 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      |
+
+## Contributors
+
+<!-- In order to automatically update the MAINTAINERS.md, you must enter a secret into your Secrets and Variables under Actions within your repository settings. The name of the secret must be PUSH_TO_PROTECTED_BRANCH and the value must be a Personal Access Token with specific permissions. Please follow [this link](https://github.com/CasperWA/push-protected?tab=readme-ov-file#notes-on-token-and-user-permissions) for more information. -->
+
+Total number of contributors: <!--CONTRIBUTOR COUNT START--> <!--CONTRIBUTOR COUNT END-->
+
+<!-- readme: contributors -start -->
+<!-- readme: contributors -end -->