Merge pull request #73 from DSACMS/nat/tier2-review

Tier 2 Template Review

tier2/{{cookiecutter.project_slug}}/CODEOWNERS.md

@@ -1,8 +1,8 @@
 # Code Owners
-<!--#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. List them by GitHub Username-->
+<!-- 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. List them by GitHub Username-->
 {usernames of code owners}
 
 # Repo Domains
-<!--#TODO List out the various domains of the project or teams of owners for that domain (e.g. Frontend, Backend, Documentation)-->
+<!-- TODO: List out the various domains of the project or teams of owners for that domain (e.g. Frontend, Backend, Documentation)-->
 documentation/* {usernames of documentation owners}
 frontend/* {usernames of frontend owners}

tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md

@@ -1,6 +1,9 @@
 <!--- # NOTE: Modify sections marked with `TODO`-->
 
 # How to Contribute
+
+<!-- Basic instructions about where to send patches, check out source code, and get development support.-->
+
 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
@@ -12,35 +15,46 @@ 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.-->
 
+<!--- TODO: If you have 'good-first-issue' or 'easy' labels for newcomers, mention them here.-->
+
+<!-- 
 ### Team Specific Guidelines
-<!--- ### TODO -->
+
+TODO: This section helps contributors understand any team structure in the project (formal or informal.) Encouraged to point towards the MAINTAINERS.md file for further details. 
+-->
 
 ### Building dependencies
-<!--- ### TODO -->
+
+<!--- TODO: This step is often skipped, so don't forget to include the steps needed to install on your platform. If you project can be multi-platform, this is an excellent place for first time contributors to send patches!-->
 
 ### Building the Project
-<!--- ### TODO -->
+
+<!--- TODO: Be sure to include build scripts and instructions, not just the source code itself! -->
 
 ### Workflow and Branching
+
 <!--- TODO: Workflow Example
 We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow/)
 
 1.  Fork the project 
-1.  Check out the `main` branch 
-1.  Create a feature branch
-1.  Write code and tests for your change 
-1.  From your branch, make a pull request against `cmsgov/cmsgov-example-repo/main` 
-1.  Work with repo maintainers to get your change reviewed 
-1.  Wait for your change to be pulled into `cmsgov/cmsgov-example-repo/main`
-1.  Delete your feature branch
+2.  Check out the `main` branch 
+3.  Create a feature branch
+4.  Write code and tests for your change 
+5.  From your branch, make a pull request against `cmsgov/cmsgov-example-repo/main` 
+6.  Work with repo maintainers to get your change reviewed 
+7.  Wait for your change to be pulled into `cmsgov/cmsgov-example-repo/main`
+8.  Delete your feature branch
 -->
 
+<!-- 
 ### Testing Conventions
-<!--- TODO -->
+
+TODO: 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
+
 <!--- TODO: Code Style Guide 
 
 1. Mention any style guides you adhere to (e.g. pep8, etc...)
@@ -51,28 +65,32 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
 
 ### Writing Issues
 
-> Example Issue Guides
-> When creating an issue please try to adhere to the following format:
-> 
->     module-name: One line summary of the issue (less than 72 characters)
-> 
->     ### Expected behavior
-> 
->     As concisely as possible, describe the expected behavior.
-> 
->    ### Actual behavior
->
->    As concisely as possible, describe the observed behavior.
->
->    ### Steps to reproduce the behavior
->
->    List all relevant steps to reproduce the observed behavior.
->
->    see our .github/ISSUE_TEMPLATE.md for more examples.
+<!---
+TODO: Example Issue Guides
+
+When creating an issue please try to adhere to the following format:
+
+    module-name: One line summary of the issue (less than 72 characters)
+
+    ### Expected behavior
+
+    As concisely as possible, describe the expected behavior.
+
+    ### Actual behavior
+
+    As concisely as possible, describe the observed behavior.
+
+    ### Steps to reproduce the behavior
+
+    List all relevant steps to reproduce the observed behavior.
+
+    see our .github/ISSUE_TEMPLATE.md for more examples.
+-->
 
-### Writing Pull Requests
 <!--- 
-### TODO: Pull request example
+### Writing Pull Requests
+
+TODO: Pull request example
 
 Comments should be formatted to a width no greater than 80 columns.
 
@@ -111,9 +129,10 @@ Some important notes regarding the summary line:
     see our .github/PULL_REQUEST_TEMPLATE.md for more examples.
 -->
 
-## Code Review
 <!--- 
-### TODO: Code Review Example
+## Code Review
+
+TODO: Code Review Example
 
 The repository on GitHub is kept in sync with an internal repository at
 github.cms.gov. For the most part this process should be transparent to the
@@ -135,10 +154,16 @@ The changes in the pull request will be collapsed into a single commit, but the
 authorship metadata will be preserved.
 -->
 
+<!--
+## Shipping Releases
+
+TODO: What cadence does your project ship new releases? (e.g. one-time, ad-hoc, periodically, upon merge of new patches) Who does so?
+-->
 
-## Documentation
 <!--- 
-### TODO: Documentation Example
+## Documentation
+
+TODO: Documentation Example
 
 We also welcome improvements to the project documentation or to the existing
 docs. Please file an [issue](https://github.com/cmsgov/cmsgov-example-repo/issues).
@@ -162,6 +187,6 @@ the American public, but you are also welcome to submit anonymously.
 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/).
+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.

tier2/{{cookiecutter.project_slug}}/README.md

@@ -11,38 +11,50 @@
 **{project mission}**
 
 ### Agency Mission
-<!-- # TODO: Must include since this is an agency-led project -->
+<!-- TODO: Must include since this is an agency-led project -->
 
 ### Team Mission
-<!-- # TODO: Must include since this is an agency-led project -->
+<!-- TODO: Must include since this is an agency-led 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}**
 
+TODO: This is a like a 'table of contents" for your documentation. Tier 0/1 projects with simple README.md files without many sections may or may not need this, but it is still extremely helpful to provide "bookmark" or "anchor" links to specific sections of your file to be referenced in tickets, docs, or other communication channels.
+
+**{list of .md at top directory and descriptions}** 
+ -->
+
+<!-- 
 ## Repository Structure
-**{list directories and descriptions}**
 
+TODO: Using the "tree -d" command can be a helpful way to generate this information, but, be sure to update it as the project evolves and changes over time.
+
+**{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 externabl contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contribributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md).
 -->
 
 ## Local Development
-<!--- # TODO - with example below:
+
+<!--- TODO - with example below:
 This project is monorepo with several apps. Please see the [api](./api/README.md) and [frontend](./frontend/README.md) READMEs for information on spinning up those projects locally. Also see the project [documentation](./documentation) for more info.
 -->
 
 ## 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
-<!--- # TODO - with example below:
+
+TODO - with example below:
 This project follows [trunk-based development](https://trunkbaseddevelopment.com/), which means:
 
 * Make small changes in [short-lived feature branches](https://trunkbaseddevelopment.com/short-lived-feature-branches/) and merge to `main` frequently.
@@ -56,7 +68,6 @@ This project uses **continuous deployment** using [Github Actions](https://githu
 Pull-requests are merged to `main` and the changes are immediately deployed to the development environment. Releases are created to push changes to production.
 -->
 
-
 ## 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).