Docs: Updated markdown files to follow Tier 3 based on repolinter output

natalialuzuriaga commented 5 months ago

Docs: Updated markdown files to follow Tier 3 based on repolinter output

Problem

Over the past couple of weeks, we have made significant changes to our markdown templates that reflect our current maturity model framework. We have developed repolinter.jsons for Tiers 1-4 that check whether repositories adhere to our framework standards. This repository has not been updated with our latest template changes, thus we have ran the Tier 3 repolinter.json to identify the missing sections and content.

Repolinter.json results:

✔ license-file-exists: Found file (LICENSE.md)
✔ security-file-exists: Found file (SECURITY.md)
✔ readme-file-exists: Found file (README.md)
✔ contributing-file-exists: Found file (CONTRIBUTING.md)
✔ maintainers-file-exists: Found file (MAINTAINERS.md)
✖ codeowners-file-exists: Did not find a file matching the specified patterns ({docs/,.github/,}CODEOWNERS.md)
⚠ governance-file-exists: Did not find a file matching the specified patterns ({docs/,.github/,}GOVERNANCE.md)
✖ community-guidelines-file-exists: Did not find a file matching the specified patterns ({docs/,.github/,}COMMUNITY_GUIDELINES.md)
✖ code-of-conduct-file-exists: Did not find a file matching the specified patterns ({docs/,.github/,}CODE_OF_CONDUCT.md)
✔ license-contains-license: Contains license (LICENSE.md)
✔ security-contains-security-and-responsible-disclosure-policy: Contains Security and Responsible Disclosure Policy (SECURITY.md)
✖ readme-contains-about-the-project: Doesn't contain About the Project (README.md)
✔ readme-contains-project-vision: Contains Project Vision (README.md)
⚠ readme-contains-project-mission: Doesn't contain Project Mission (README.md)
⚠ readme-contains-agency-mission: Doesn't contain Agency Mission (README.md)
⚠ readme-contains-team-mission: Doesn't contain Team Mission (README.md)
✖ readme-contains-core-team: Doesn't contain Core Team (README.md)
✖ readme-contains-documentation-index: Doesn't contain Documentation Index (README.md)
✖ readme-contains-repository-structure: Doesn't contain Repository Structure (README.md)
✖ readme-contains-development-and-software-delivery-lifecycle: Doesn't contain Development and Software Delivery Lifecycle (README.md)
✖ readme-contains-local-development: Doesn't contain Local Development (README.md)
✖ readme-contains-coding-style-and-linters: Doesn't contain Coding Style and Linters (README.md)
✖ readme-contains-branching-model: Doesn't contain Branching Model (README.md)
✔ readme-contains-contributing: Contains Contributing (README.md)
✖ readme-contains-codeowners: Doesn't contain Codeowners (README.md)
✖ readme-contains-community: Doesn't contain Community (README.md)
✖ readme-contains-community-guidelines: Doesn't contain Community Guidelines (README.md)
⚠ readme-contains-governance: Doesn't contain Governance (README.md)
✖ readme-contains-feedback: Doesn't contain Feedback (README.md)
⚠ readme-contains-glossary: Doesn't contain Glossary (README.md)
✔ readme-contains-policies: Contains Policies (README.md)
✖ readme-contains-open-source-policy: Doesn't contain Open Source Policy (README.md)
✖ readme-contains-security-and-responsible-disclosure-policy: Doesn't contain Security and Responsible Disclosure Policy (README.md)
✔ readme-contains-public-domain: Contains Public domain (README.md)
✔ contributing-contains-how-to-contribute: Contains How to Contribute (CONTRIBUTING.md)
✔ contributing-contains-getting-started: Contains Getting Started (CONTRIBUTING.md)
✔ contributing-contains-team-specific-guidelines: Contains Team Specific Guidelines (CONTRIBUTING.md)
✔ contributing-contains-building-dependencies: Contains Building dependencies (CONTRIBUTING.md)
✔ contributing-contains-building-the-project: Contains Building the Project (CONTRIBUTING.md)
✔ contributing-contains-workflow-and-branching: Contains Workflow and Branching (CONTRIBUTING.md)
✔ contributing-contains-testing-conventions: Contains Testing Conventions (CONTRIBUTING.md)
✔ contributing-contains-coding-style-and-linters: Contains Coding Style and Linters (CONTRIBUTING.md)
✔ contributing-contains-writing-issues: Contains ISSUE_TEMPLATE.md | Issues (CONTRIBUTING.md)
✖ contributing-contains-writing-pull-requests: Doesn't contain Writing Pull Requests (CONTRIBUTING.md)
✖ contributing-contains-reviewing-pull-requests: Doesn't contain Reviewing Pull Requests (CONTRIBUTING.md)
⚠ contributing-contains-shipping-releases: Doesn't contain Shipping Releases (CONTRIBUTING.md)
✔ contributing-contains-documentation: Contains Documentation (CONTRIBUTING.md)
✔ contributing-contains-policies: Contains Policies (CONTRIBUTING.md)
✔ contributing-contains-open-source-policy: Contains Open Source Policy (CONTRIBUTING.md)
✔ contributing-contains-security-and-responsible-disclosure-policy: Contains Security and Responsible Disclosure Policy (CONTRIBUTING.md)
✔ contributing-contains-public-domain: Contains Public domain (CONTRIBUTING.md)
✔ maintainers-contains-maintainers: Contains Maintainers (MAINTAINERS.md)
✔ maintainers-contains-maintainers-list: Contains Maintainers: (MAINTAINERS.md)
✔ maintainers-contains-approvers-list: Contains Approvers: (MAINTAINERS.md)
✔ maintainers-contains-reviewers-list: Contains Reviewers: (MAINTAINERS.md)
✔ governance-contains-governance: Did not find file matching the specified patterns ({docs/,.github/,}GOVERNANCE.md)
✔ code-owners-contains-list-of-users: Did not find file matching the specified patterns ({docs/,.github/,}CODEOWNERS.md)
✔ code-owners-contains-repo-domains: Did not find file matching the specified patterns ({docs/,.github/,}CODEOWNERS.md)
✔ community-guidelines-contains-principles: Did not find file matching the specified patterns ({docs/,.github/,}COMMUNITY_GUIDELINES.md)
✔ community-guidelines-contains-community-guidelines: Did not find file matching the specified patterns ({docs/,.github/,}COMMUNITY_GUIDELINES.md)
✔ community-guidelines-contains-acknowledgements: Did not find file matching the specified patterns ({docs/,.github/,}COMMUNITY_GUIDELINES.md)
✔ code-of-conduct-contains-contributor-code-of-conduct: Did not find file matching the specified patterns ({docs/,.github/,}CODE_OF_CONDUCT.md)
✔ code-of-conduct-contains-acknowledgements: Did not find file matching the specified patterns ({docs/,.github/,}CODE_OF_CONDUCT.md)

Solution

This PR resolves repolinter errors of missing files and sections. Updates include:

Adding COMMUNITY_GUIDELINES.md, CODE_OF_CONDUCT.md, and CODEOWNERS.md
Updated README.md to include project information and software development practices.
Updating CONTRIBUTING.md to include build instructions and software development practices.

Result

This repository now adheres to the Tier 3 Maturity Model: Working in Public

Test Plan

Ran repolinter after making updates. Here are the results:

Target directory: /Users/l9a1/Desktop/metrics
Axiom language failed to run with error: Linguist not installed
Axiom license failed to run with error: Licensee not installed
Lint:
✔ license-file-exists: Found file (LICENSE.md)
✔ security-file-exists: Found file (SECURITY.md)
✔ readme-file-exists: Found file (README.md)
✔ contributing-file-exists: Found file (CONTRIBUTING.md)
✔ maintainers-file-exists: Found file (MAINTAINERS.md)
✔ codeowners-file-exists: Found file (CODEOWNERS.md)
⚠ governance-file-exists: Did not find a file matching the specified patterns ({docs/,.github/,}GOVERNANCE.md)
✔ community-guidelines-file-exists: Found file (COMMUNITY_GUIDELINES.md)
✔ code-of-conduct-file-exists: Found file (CODE_OF_CONDUCT.md)
✔ license-contains-license: Contains license (LICENSE.md)
✔ security-contains-security-and-responsible-disclosure-policy: Contains Security and Responsible Disclosure Policy (SECURITY.md)
✔ readme-contains-about-the-project: Contains About the Project (README.md)
✔ readme-contains-project-vision: Contains Project Vision (README.md)
⚠ readme-contains-project-mission: Doesn't contain Project Mission (README.md)
⚠ readme-contains-agency-mission: Doesn't contain Agency Mission (README.md)
⚠ readme-contains-team-mission: Doesn't contain Team Mission (README.md)
✔ readme-contains-core-team: Contains Core Team (README.md)
✔ readme-contains-documentation-index: Contains Documentation Index (README.md)
✔ readme-contains-repository-structure: Contains Repository Structure (README.md)
✔ readme-contains-development-and-software-delivery-lifecycle: Contains Development and Software Delivery Lifecycle (README.md)
✔ readme-contains-local-development: Contains Local Development (README.md)
✔ readme-contains-coding-style-and-linters: Contains Coding Style and Linters (README.md)
✔ readme-contains-branching-model: Contains Branching Model (README.md)
✔ readme-contains-contributing: Contains Contributing (README.md)
✔ readme-contains-codeowners: Contains Codeowners (README.md)
✔ readme-contains-community: Contains Community (README.md)
✔ readme-contains-community-guidelines: Contains Community Guidelines (README.md)
⚠ readme-contains-governance: Doesn't contain Governance (README.md)
✔ readme-contains-feedback: Contains Feedback (README.md)
⚠ readme-contains-glossary: Doesn't contain Glossary (README.md)
✔ readme-contains-policies: Contains Policies (README.md)
✔ readme-contains-open-source-policy: Contains Open Source Policy (README.md)
✔ readme-contains-security-and-responsible-disclosure-policy: Contains Security and Responsible Disclosure Policy (README.md)
✔ readme-contains-public-domain: Contains Public domain (README.md)
✔ contributing-contains-how-to-contribute: Contains How to Contribute (CONTRIBUTING.md)
✔ contributing-contains-getting-started: Contains Getting Started (CONTRIBUTING.md)
✔ contributing-contains-team-specific-guidelines: Contains Team Specific Guidelines (CONTRIBUTING.md)
✔ contributing-contains-building-dependencies: Contains Building dependencies (CONTRIBUTING.md)
✔ contributing-contains-building-the-project: Contains Building the Project (CONTRIBUTING.md)
✔ contributing-contains-workflow-and-branching: Contains Workflow and Branching (CONTRIBUTING.md)
✔ contributing-contains-testing-conventions: Contains Testing Conventions (CONTRIBUTING.md)
✔ contributing-contains-coding-style-and-linters: Contains Coding Style and Linters (CONTRIBUTING.md)
✔ contributing-contains-writing-issues: Contains ISSUE_TEMPLATE.md | Issues (CONTRIBUTING.md)
✔ contributing-contains-writing-pull-requests: Contains Writing Pull Requests (CONTRIBUTING.md)
✔ contributing-contains-reviewing-pull-requests: Contains Reviewing Pull Requests (CONTRIBUTING.md)
⚠ contributing-contains-shipping-releases: Doesn't contain Shipping Releases (CONTRIBUTING.md)
✔ contributing-contains-documentation: Contains Documentation (CONTRIBUTING.md)
✔ contributing-contains-policies: Contains Policies (CONTRIBUTING.md)
✔ contributing-contains-open-source-policy: Contains Open Source Policy (CONTRIBUTING.md)
✔ contributing-contains-security-and-responsible-disclosure-policy: Contains Security and Responsible Disclosure Policy (CONTRIBUTING.md)
✔ contributing-contains-public-domain: Contains Public domain (CONTRIBUTING.md)
✔ maintainers-contains-maintainers: Contains Maintainers (MAINTAINERS.md)
✔ maintainers-contains-maintainers-list: Contains Maintainers: (MAINTAINERS.md)
✔ maintainers-contains-approvers-list: Contains Approvers: (MAINTAINERS.md)
✔ maintainers-contains-reviewers-list: Contains Reviewers: (MAINTAINERS.md)
✔ governance-contains-governance: Did not find file matching the specified patterns ({docs/,.github/,}GOVERNANCE.md)
✔ code-owners-contains-list-of-users: Contains Code Owners (CODEOWNERS.md)
✔ code-owners-contains-repo-domains: Contains documentation | frontend | backend | Repo Domains (CODEOWNERS.md)
✔ community-guidelines-contains-principles: Contains Principles (COMMUNITY_GUIDELINES.md)
✔ community-guidelines-contains-community-guidelines: Contains Community Guidelines (COMMUNITY_GUIDELINES.md)
✔ community-guidelines-contains-acknowledgements: Contains Acknowledgements (COMMUNITY_GUIDELINES.md)
✔ code-of-conduct-contains-contributor-code-of-conduct: Contains Contributor Code of Conduct (CODE_OF_CONDUCT.md)
✔ code-of-conduct-contains-acknowledgements: Contains Acknowledgements (CODE_OF_CONDUCT.md)

natalialuzuriaga commented 5 months ago

Outstanding questions for @decause-gov:

I updated the project name to be: CMS Repository Metrics Website. Let me know if we'd like to change that
Should we include any of these recommended sections: Team Mission, Agency Mission, Project Mission, GOVERNANCE.md

natalialuzuriaga commented 5 months ago

@IsaacMilarky:

In the README, I moved the Getting Started subsection and Installation subsection to under the Local Development section. Lmk if we want that there or should move it somewhere else
In README, want to specificaly call out Coding Style and Linters and Branching Model for your review
In CONTRIBUTING, want to call out Getting Started and Building Dependencies and Building Project sections

decause-gov commented 5 months ago

Outstanding questions for @decause-gov:

* I updated the project name to be: CMS Repository Metrics Website. Let me know if we'd like to change that

* Should we include any of these recommended sections: Team Mission, Agency Mission, Project Mission, GOVERNANCE.md

Recommended sections for Team/Agency/Project Mission should get filled in eventually, let's file a ticket.

We're not at the point where we're taking on an open GOVERNANCE.md structure, but we could mention more about how the project functions. Let's discuss this more as a team, and perhaps add a ticket or add to an existing ticket to clarify GOVERNANCE.md for this and other Tier3 projects.

IsaacMilarky commented 5 months ago

In the README, I moved the Getting Started subsection and Installation subsection to under the Local Development section. Lmk if we want that there or should move it somewhere else

That sounds good to me. We have a short explanation of how to install and run it on the readme still in the changes so its fine.

IsaacMilarky commented 5 months ago

In README, want to specificaly call out Coding Style and Linters and Branching Model for your review

In CONTRIBUTING, want to call out Getting Started and Building Dependencies and Building Project sections

Both LGTM

DSACMS / metrics