A Tier 1 project refers to an informational or historical project that has been released publicly. However, it does not have planned future updates or maintenance by the original authors or contributors. These projects typically include code samples, prototypes, public documentation, or other types of resources that are made available for use but won't receive ongoing updates or active development.
The main purpose of a Tier 1 project is to share knowledge and provide information from past work. Though available for public consumption, the project is not expected to evolve or expand in the future. Contributors may not engage in continuous development or issue resolution.
- Publicly released without planned future development or maintenance.
- Primarily informational or historical in nature.
- May still provide value to the community, but it is not actively worked on.
There are specific files that are required and recommended to include in the repository as part of the CMS Open Source Program Office's repository hygiene guidelines and standards.
| File | Requirement | Description |
|---|---|---|
LICENSE |
Mandatory | Defines the licensing terms under which the project is distributed. |
SECURITY.md |
Mandatory | Outlines the agency's security policies, including how to report security issues or vulnerabilities in the code. |
README.md |
Mandatory | Provides a comprehensive overview of the project, including its purpose, how to install or use it, and any relevant information for users or developers. |
CONTRIBUTING.md |
Recommended | Offers guidelines for contributing to the project, including code standards, how to submit issues, and creating pull requests. |
For more information about required sections and content within the files above, please visit maturity-model-tiers.md.
Located in the .github directory are GitHub Action workflows that can be used to regularly update your repository.