From d7de9ae60c4a2d0a7329a9cecda0a58bd523c3f6 Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Tue, 1 Oct 2024 08:37:57 -0700 Subject: [PATCH] Added tier 2 README.md Signed-off-by: Natalia Luzuriaga --- tier1/README.md | 4 ++-- tier2/README.md | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 2 deletions(-) create mode 100644 tier2/README.md diff --git a/tier1/README.md b/tier1/README.md index 892d280..4dec157 100644 --- a/tier1/README.md +++ b/tier1/README.md @@ -1,4 +1,4 @@ -# Tier 1 Project: One-Time Release +# Tier 1: One-Time Release ## What is a Tier 1 Project? @@ -22,7 +22,7 @@ In a Tier 1 project, there are specific files that are required, recommended, or |-----------------------|-----------------|-------------------------------------------------------------------------------------------------------------| | `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 an overview of the project, including its purpose, how to install or use it, and any relevant information for users or developers. | +| `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)[https://github.com/DSACMS/repo-scaffolder/blob/main/maturity-model-tiers.md]. \ No newline at end of file diff --git a/tier2/README.md b/tier2/README.md new file mode 100644 index 0000000..3e39592 --- /dev/null +++ b/tier2/README.md @@ -0,0 +1,32 @@ +# Tier 2: Close Collaboration + +## What is a Tier 2 Project? + +A **Tier 2** project is a **collaborative effort** that typically occurs within a team or operational division (OpDiv). The project follows an **innersource working style**, where internal teams collaborate using open source best practices but within the confines of a private or internal environment. The project is not meant for broad public contribution but rather for **internal collaboration**. + +Innersource projects often allow different teams within the same organization to contribute, fostering collaboration and code-sharing internally while maintaining control over external access. + +### Key Characteristics of a Tier 2 Project: +- Focuses on **collaborating within a smaller team** or internal group. +- Utilizes **innersource practices**, where internal teams work collaboratively on code, borrowing from open source workflows but keeping the work within the organization. +- Projects may be shared among internal stakeholders or divisions. +- **Not publicly open** to the broader community for contributions. + +--- + +## Files for a Tier 2 Project + +In a Tier 2 project, there are specific files that are required, recommended, or not recommended 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` | Mandatory | Offers guidelines for contributing to the project, including code standards, how to submit issues, and creating pull requests. | +| `MAINTAINERS.md` | Recommended | Lists the individuals responsible for maintaining the project as well as reviewing and approving pull requests. | +| `CODEOWNERS.md` | Recommended | Defines ownership of various sections of the repository. | +| `COMMUNITY_GUIDELINES.md` | Mandatory | Outlines how team members should engage with each other while working on the project, including behavior expectations for internal contributors. | +| `CODE_OF_CONDUCT.md` | Mandatory | Establishes guidelines for professional and respectful behavior to foster a collaborative environment. | + +For more information about required sections and content within the files above, please visit (maturity-model-tiers.md)[https://github.com/DSACMS/repo-scaffolder/blob/main/maturity-model-tiers.md].