Skip to content

Commit

Permalink
Merge pull request #76 from DSACMS/nat/tier0-review-2
Browse files Browse the repository at this point in the history 
Tier 0 Template Review
  • Loading branch information
@natalialuzuriaga
natalialuzuriaga authored Mar 7, 2024
2 parents 4846821 + fa418f2 commit 7a5802f
Show file tree
Hide file tree
Showing 2 changed files with 213 additions and 11 deletions.
119 changes: 119 additions & 0 deletions tier0/{{cookiecutter.project_slug}}/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
<!--- # NOTE: Modify sections marked with `TODO` -->

<!--
# How to Contribute
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
TODO: If you have 'good-first-issue' or 'easy' labels for newcomers, mention them here. -->

<!--
### Building dependencies
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: 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
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: 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...)
2. Mention any linters your project uses (e.g. flake8, jslint, etc...)
3. Mention any naming conventions your project uses (e.g. Semantic Versioning, CamelCasing, etc...)
4. Mention any other content guidelines the project adheres to (e.g. plainlanguage.gov, etc...)
-->

<!--
### Issues
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.
-->

<!--
## 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).
-->

<!--
## 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:[email protected]).
### Security and Responsible Disclosure Policy
*Submit a vulnerability:* Unfortunately, we cannot accept secure submissions via
email or via GitHub Issues. Please use our website to submit vulnerabilities at
[https://hhs.responsibledisclosure.com](https://hhs.responsibledisclosure.com).
HHS maintains an acknowledgements page to recognize your efforts on behalf of
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/) 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.
-->
105 changes: 94 additions & 11 deletions tier0/{{cookiecutter.project_slug}}/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,43 @@

{{ cookiecutter.project_description }}

## Getting Started
## About the Project
**{project statement}**

<!---
### Project Vision
**{project vision}** -->

### Project Information
<!--
### Project Mission
**{project mission}** -->

<!--
### Agency Mission
TODO: Recommended to include since this is an agency-led project -->

<!--
### Team Mission
TODO: Recommended to include since this is an agency-led project -->

## Core Team
A full list of contributors can be found on [https://github.cms.gov/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/graphs/contributors](https://github.cms.gov/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/graphs/contributors).

<!--
## Documentation Index
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
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}**
-->

## Running Locally

Expand Down Expand Up @@ -39,16 +71,67 @@
1. Visit [localhost:9001](https://localhost:9001) to view the server
-->

## Authors and Maintainers
A full list of contributors can be found on [https://github.cms.gov/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/graphs/contributors](https://github.cms.gov/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/graphs/contributors).
<!--
## 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:
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.
* Be open to submitting multiple small pull requests for a single ticket (i.e. reference the same ticket across multiple pull requests).
* Treat each change you merge to `main` as immediately deployable to production. Do not merge changes that depend on subsequent changes you plan to make, even if you plan to make those changes shortly.
* Ticket any unfinished or partially finished work.
* Tests should be written for changes introduced, and adhere to the text percentage threshold determined by the project.
This project uses **continuous deployment** using [Github Actions](https://github.com/features/actions) which is configured in the [./github/worfklows](.github/workflows) directory.
Pull-requests are merged to `main` and the changes are immediately deployed to the development environment. Releases are created to push changes to production.
-->

<!--
## Community
The **{project name}** 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.
-->

<!--
## Glossary
Information about terminology and acronyms used in this documentation may be found in [GLOSSARY.md](GLOSSARY.md).
-->

## 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:[email protected]).

### Security and Responsible Disclosure Policy

*Submit a vulnerability:* Unfortunately, we cannot accept secure submissions via
email or via GitHub Issues. Please use our website to submit vulnerabilities at
[https://hhs.responsibledisclosure.com](https://hhs.responsibledisclosure.com).
HHS maintains an acknowledgements page to recognize your efforts on behalf of
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 licensed within 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).
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.
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.

0 comments on commit 7a5802f

Please sign in to comment.