From 6678ad0037e555c075f8ef839519102c9bb29f7f Mon Sep 17 00:00:00 2001 From: Sachin Panayil Date: Thu, 5 Dec 2024 14:58:49 -0500 Subject: [PATCH 1/6] added base templates in config Signed-off-by: Sachin Panayil --- .../repolinter.json | 508 +++++++++--------- 1 file changed, 254 insertions(+), 254 deletions(-) diff --git a/tier1/{{cookiecutter.project_slug}}/repolinter.json b/tier1/{{cookiecutter.project_slug}}/repolinter.json index 466734cf..a33ec90a 100644 --- a/tier1/{{cookiecutter.project_slug}}/repolinter.json +++ b/tier1/{{cookiecutter.project_slug}}/repolinter.json @@ -12,10 +12,10 @@ "rule": { "type": "file-existence", "options": { - "globsAny": [ - "{docs/,.github/,}LICENSE*" - ], - "nocase": true + "globsAny": ["{docs/,.github/,}LICENSE*"], + "nocase": true, + "file-name": "LICENSE", + "file-content": "This project is licensed under..." } } }, @@ -24,9 +24,9 @@ "rule": { "type": "file-existence", "options": { - "globsAny": [ - "{docs/,.github/,}SECURITY.md" - ] + "globsAny": ["{docs/,.github/,}SECURITY.md"], + "file-name": "SECURITY.md", + "file-content": "Security policy and procedures..." } } }, @@ -35,10 +35,10 @@ "rule": { "type": "file-existence", "options": { - "globsAny": [ - "README.md" - ], - "nocase": true + "globsAny": ["README.md"], + "nocase": true, + "file-name": "README.md", + "file-content": "Project documentation and overview..." } } }, @@ -47,10 +47,10 @@ "rule": { "type": "file-existence", "options": { - "globsAny": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], - "nocase": true + "globsAny": ["{docs/,.github/,}CONTRIBUTING.md"], + "nocase": true, + "file-name": "CONTRIBUTING.md", + "file-content": "Guidelines for contributing..." } } }, @@ -59,9 +59,9 @@ "rule": { "type": "file-existence", "options": { - "globsAny": [ - "{docs/,.github/,}MAINTAINERS.md" - ] + "globsAny": ["{docs/,.github/,}MAINTAINERS.md"], + "file-name": "MAINTAINERS.md", + "file-content": "List of project maintainers..." } } }, @@ -70,9 +70,9 @@ "rule": { "type": "file-existence", "options": { - "globsAny": [ - "{docs/,.github/,}CODEOWNERS.md" - ] + "globsAny": ["{docs/,.github/,}CODEOWNERS.md"], + "file-name": "CODEOWNERS.md", + "file-content": "Code ownership assignments..." } } }, @@ -81,9 +81,9 @@ "rule": { "type": "file-existence", "options": { - "globsAny": [ - "{docs/,.github/,}GOVERNANCE.md" - ] + "globsAny": ["{docs/,.github/,}GOVERNANCE.md"], + "file-name": "GOVERNANCE.md", + "file-content": "Project governance structure..." } } }, @@ -92,9 +92,9 @@ "rule": { "type": "file-existence", "options": { - "globsAny": [ - "{docs/,.github/,}COMMUNITY_GUIDELINES.md" - ] + "globsAny": ["{docs/,.github/,}COMMUNITY_GUIDELINES.md"], + "file-name": "COMMUNITY_GUIDELINES.md", + "file-content": "Community participation guidelines..." } } }, @@ -103,9 +103,9 @@ "rule": { "type": "file-existence", "options": { - "globsAny": [ - "{docs/,.github/,}CODE_OF_CONDUCT.md" - ] + "globsAny": ["{docs/,.github/,}CODE_OF_CONDUCT.md"], + "file-name": "CODE_OF_CONDUCT.md", + "file-content": "Expected conduct guidelines..." } } }, @@ -114,11 +114,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}LICENSE*" - ], + "globsAll": ["{docs/,.github/,}LICENSE*"], "content": "license", - "flags": "i" + "flags": "i", + "file-name": "LICENSE", + "file-content": "MIT License\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted..." } } }, @@ -127,11 +127,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}SECURITY.md" - ], + "globsAll": ["{docs/,.github/,}SECURITY.md"], "content": "Security and Responsible Disclosure Policy", - "flags": "i" + "flags": "i", + "file-name": "SECURITY.md", + "file-content": "\n## Security and Responsible Disclosure Policy\nDetails about security vulnerabilities and how to report them..." } } }, @@ -140,11 +140,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "About the Project", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## About the Project\nA description of the project's purpose and functionality..." } } }, @@ -153,11 +153,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Project Vision", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Project Vision\nThe long-term goals and aspirations for this project..." } } }, @@ -166,37 +166,37 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Project Mission", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Project Mission\nThe core mission and objectives driving this project..." } } }, "readme-contains-agency-mission": { - "level": "warning", - "rule": { - "type": "file-contents", - "options": { - "globsAll": [ - "README.md" - ], - "content": "Agency Mission", - "flags": "i" + "level": "warning", + "rule": { + "type": "file-contents", + "options": { + "globsAll": ["README.md"], + "content": "Agency Mission", + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Agency Mission\nThe mission of our agency and how this project aligns..." + } } - } }, "readme-contains-team-mission": { "level": "warning", "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Team Mission", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Team Mission\nOur team's goals and how we work together..." } } }, @@ -205,11 +205,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Core Team", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Core Team\nKey members and contributors of the project..." } } }, @@ -218,11 +218,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Documentation Index", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Documentation Index\nLinks to all project documentation..." } } }, @@ -231,11 +231,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Repository Structure", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Repository Structure\nOverview of key directories and files..." } } }, @@ -244,11 +244,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Development and Software Delivery Lifecycle", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Development and Software Delivery Lifecycle\nStages from development to deployment..." } } }, @@ -257,11 +257,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Local Development", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Local Development\nSteps to set up and run the project locally..." } } }, @@ -270,11 +270,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Coding Style and Linters", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Coding Style and Linters\nCoding standards and tools for maintaining code quality..." } } }, @@ -283,11 +283,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Branching Model", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Branching Model\nGit workflow and branch naming conventions..." } } }, @@ -296,11 +296,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Contributing", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Contributing\nGuidelines for contributing to the project..." } } }, @@ -309,11 +309,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Codeowners", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Codeowners\nList of maintainers responsible for different parts..." } } }, @@ -322,11 +322,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Community", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Community\nInformation about our community and how to get involved..." } } }, @@ -335,11 +335,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Community Guidelines", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Community Guidelines\nStandards for community interaction and behavior..." } } }, @@ -348,11 +348,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Governance", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Governance\nProject governance structure and decision-making process..." } } }, @@ -361,11 +361,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Feedback", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Feedback\nHow to provide feedback and suggestions..." } } }, @@ -374,11 +374,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Glossary", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Glossary\nDefinitions of key terms and concepts..." } } }, @@ -387,11 +387,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Policies", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Policies\nProject policies and guidelines..." } } }, @@ -400,11 +400,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Open Source Policy", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Open Source Policy\nGuidelines for open source contributions..." } } }, @@ -413,11 +413,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Security and Responsible Disclosure Policy", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Security and Responsible Disclosure Policy\nHow to report..." } } }, @@ -426,11 +426,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "README.md" - ], + "globsAll": ["README.md"], "content": "Public domain", - "flags": "i" + "flags": "i", + "file-name": "README.md", + "file-content": "\n## Public Domain\nInformation about public domain status..." } } }, @@ -439,11 +439,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "How to Contribute", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## How to Contribute\nSteps for making contributions to the project..." } } }, @@ -452,11 +452,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Getting Started", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Getting Started\nInitial setup steps for contributors..." } } }, @@ -465,11 +465,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Team Specific Guidelines", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Team Specific Guidelines\nTeam-specific contribution requirements..." } } }, @@ -478,11 +478,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Building dependencies", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Building Dependencies\nSteps to build project dependencies..." } } }, @@ -491,11 +491,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Building the Project", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Building the Project\nSteps to build and test the project..." } } }, @@ -504,11 +504,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Workflow and Branching", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Workflow and Branching\nGit workflow guidelines and branch conventions..." } } }, @@ -517,11 +517,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Testing Conventions", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Testing Conventions\nTesting requirements and guidelines..." } } }, @@ -530,11 +530,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Coding Style and Linters", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Coding Style and Linters\nCode formatting and linting requirements..." } } }, @@ -543,11 +543,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "ISSUE_TEMPLATE.md | Issues", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Writing Issues\nGuidelines for creating effective issue reports..." } } }, @@ -556,11 +556,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Writing Pull Requests", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Writing Pull Requests\nGuidelines for submitting pull requests..." } } }, @@ -569,11 +569,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Reviewing Pull Requests", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Reviewing Pull Requests\nGuidelines for reviewing contributions..." } } }, @@ -582,11 +582,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Shipping Releases", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Shipping Releases\nProcess for creating and publishing releases..." } } }, @@ -595,12 +595,12 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Documentation", - "flags": "i" - } + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Documentation\nGuidelines for writing and updating documentation..." + } } }, "contributing-contains-policies": { @@ -608,11 +608,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Policies", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Policies\nProject policies for contributors..." } } }, @@ -621,11 +621,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Open Source Policy", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Open Source Policy\nOpen source guidelines and requirements..." } } }, @@ -634,11 +634,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Security and Responsible Disclosure Policy", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Security and Responsible Disclosure Policy\nGuidelines for reporting security issues..." } } }, @@ -647,11 +647,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CONTRIBUTING.md" - ], + "globsAll": ["{docs/,.github/,}CONTRIBUTING.md"], "content": "Public domain", - "flags": "i" + "flags": "i", + "file-name": "CONTRIBUTING.md", + "file-content": "\n## Public Domain\nInformation about public domain status..." } } }, @@ -660,11 +660,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}MAINTAINERS.md" - ], + "globsAll": ["{docs/,.github/,}MAINTAINERS.md"], "content": "Maintainers", - "flags": "i" + "flags": "i", + "file-name": "MAINTAINERS.md", + "file-content": "\n## Maintainers\nList of project maintainers and responsibilities..." } } }, @@ -673,11 +673,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}MAINTAINERS.md" - ], + "globsAll": ["{docs/,.github/,}MAINTAINERS.md"], "content": "Maintainers:", - "flags": "i" + "flags": "i", + "file-name": "MAINTAINERS.md", + "file-content": "\n## Maintainers:\nCurrent project maintainers and their roles..." } } }, @@ -686,11 +686,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}MAINTAINERS.md" - ], + "globsAll": ["{docs/,.github/,}MAINTAINERS.md"], "content": "Approvers:", - "flags": "i" + "flags": "i", + "file-name": "MAINTAINERS.md", + "file-content": "\n## Approvers:\nList of people who can approve changes..." } } }, @@ -699,11 +699,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}MAINTAINERS.md" - ], + "globsAll": ["{docs/,.github/,}MAINTAINERS.md"], "content": "Reviewers:", - "flags": "i" + "flags": "i", + "file-name": "MAINTAINERS.md", + "file-content": "\n## Reviewers:\nList of designated code reviewers..." } } }, @@ -712,11 +712,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}GOVERNANCE.md" - ], + "globsAll": ["{docs/,.github/,}GOVERNANCE.md"], "content": "Governance", - "flags": "i" + "flags": "i", + "file-name": "GOVERNANCE.md", + "file-content": "\n## Governance\nProject governance structure and processes..." } } }, @@ -725,11 +725,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CODEOWNERS.md" - ], + "globsAll": ["{docs/,.github/,}CODEOWNERS.md"], "content": "Code Owners", - "flags": "i" + "flags": "i", + "file-name": "CODEOWNERS.md", + "file-content": "\n## Code Owners\nList of code owners and their areas..." } } }, @@ -738,11 +738,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CODEOWNERS.md" - ], + "globsAll": ["{docs/,.github/,}CODEOWNERS.md"], "content": "documentation | frontend | backend | Repo Domains", - "flags": "i" + "flags": "i", + "file-name": "CODEOWNERS.md", + "file-content": "\n## Repository Domains\nBreakdown of different project areas..." } } }, @@ -751,11 +751,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}COMMUNITY_GUIDELINES.md" - ], + "globsAll": ["{docs/,.github/,}COMMUNITY_GUIDELINES.md"], "content": "Principles", - "flags": "i" + "flags": "i", + "file-name": "COMMUNITY_GUIDELINES.md", + "file-content": "\n## Principles\nCore principles guiding our community..." } } }, @@ -764,11 +764,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}COMMUNITY_GUIDELINES.md" - ], + "globsAll": ["{docs/,.github/,}COMMUNITY_GUIDELINES.md"], "content": "Community Guidelines", - "flags": "i" + "flags": "i", + "file-name": "COMMUNITY_GUIDELINES.md", + "file-content": "\n## Community Guidelines\nRules and expectations for community members..." } } }, @@ -777,11 +777,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}COMMUNITY_GUIDELINES.md" - ], + "globsAll": ["{docs/,.github/,}COMMUNITY_GUIDELINES.md"], "content": "Acknowledgements", - "flags": "i" + "flags": "i", + "file-name": "COMMUNITY_GUIDELINES.md", + "file-content": "\n## Acknowledgements\nRecognition of community contributors..." } } }, @@ -790,11 +790,11 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CODE_OF_CONDUCT.md" - ], + "globsAll": ["{docs/,.github/,}CODE_OF_CONDUCT.md"], "content": "Contributor Code of Conduct", - "flags": "i" + "flags": "i", + "file-name": "CODE_OF_CONDUCT.md", + "file-content": "\n## Contributor Code of Conduct\nExpectations for contributor behavior..." } } }, @@ -803,13 +803,13 @@ "rule": { "type": "file-contents", "options": { - "globsAll": [ - "{docs/,.github/,}CODE_OF_CONDUCT.md" - ], + "globsAll": ["{docs/,.github/,}CODE_OF_CONDUCT.md"], "content": "Acknowledgements", - "flags": "i" + "flags": "i", + "file-name": "CODE_OF_CONDUCT.md", + "file-content": "\n## Acknowledgements\nRecognition of code of conduct sources..." } } } } - } + } \ No newline at end of file From 71bbada339fc04c6df6fd3ffe2e58ef2ada047d8 Mon Sep 17 00:00:00 2001 From: Sachin Panayil Date: Thu, 5 Dec 2024 17:17:59 -0500 Subject: [PATCH 2/6] Properly filled out content fields Signed-off-by: Sachin Panayil --- .../repolinter.json | 139 ++++++++++-------- 1 file changed, 76 insertions(+), 63 deletions(-) diff --git a/tier1/{{cookiecutter.project_slug}}/repolinter.json b/tier1/{{cookiecutter.project_slug}}/repolinter.json index a33ec90a..417742e7 100644 --- a/tier1/{{cookiecutter.project_slug}}/repolinter.json +++ b/tier1/{{cookiecutter.project_slug}}/repolinter.json @@ -15,7 +15,7 @@ "globsAny": ["{docs/,.github/,}LICENSE*"], "nocase": true, "file-name": "LICENSE", - "file-content": "This project is licensed under..." + "file-content": "#License \n Remove this line and attach the license that is being used for this project. For helping choosing a license, visit this website: https://choosealicense.com/ \n" } } }, @@ -26,7 +26,7 @@ "options": { "globsAny": ["{docs/,.github/,}SECURITY.md"], "file-name": "SECURITY.md", - "file-content": "Security policy and procedures..." + "file-content": "#Security and Responsible Disclosure Policy \n" } } }, @@ -38,7 +38,7 @@ "globsAny": ["README.md"], "nocase": true, "file-name": "README.md", - "file-content": "Project documentation and overview..." + "file-content": "#Replace with Project Name \n" } } }, @@ -50,7 +50,7 @@ "globsAny": ["{docs/,.github/,}CONTRIBUTING.md"], "nocase": true, "file-name": "CONTRIBUTING.md", - "file-content": "Guidelines for contributing..." + "file-content": "#How to Contribute \n \n 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. \n We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md). \n" } } }, @@ -61,7 +61,7 @@ "options": { "globsAny": ["{docs/,.github/,}MAINTAINERS.md"], "file-name": "MAINTAINERS.md", - "file-content": "List of project maintainers..." + "file-content": "#Maintainers \n \n This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS.md) for list of reviewers for different parts of the codebase. Team members include: \n" } } }, @@ -72,7 +72,7 @@ "options": { "globsAny": ["{docs/,.github/,}CODEOWNERS.md"], "file-name": "CODEOWNERS.md", - "file-content": "Code ownership assignments..." + "file-content": "#Code Owners \n \n" } } }, @@ -83,7 +83,7 @@ "options": { "globsAny": ["{docs/,.github/,}GOVERNANCE.md"], "file-name": "GOVERNANCE.md", - "file-content": "Project governance structure..." + "file-content": "#Governance \n \n This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). \n" } } }, @@ -94,7 +94,7 @@ "options": { "globsAny": ["{docs/,.github/,}COMMUNITY_GUIDELINES.md"], "file-name": "COMMUNITY_GUIDELINES.md", - "file-content": "Community participation guidelines..." + "file-content": "#Open Source Community Guidelines \n This document contains principles and guidelines for participating in the {name_of_project_here} open source community. \n" } } }, @@ -105,7 +105,7 @@ "options": { "globsAny": ["{docs/,.github/,}CODE_OF_CONDUCT.md"], "file-name": "CODE_OF_CONDUCT.md", - "file-content": "Expected conduct guidelines..." + "file-content": "#Code of Conduct \n" } } }, @@ -118,7 +118,7 @@ "content": "license", "flags": "i", "file-name": "LICENSE", - "file-content": "MIT License\n\nCopyright (c) [year] [fullname]\n\nPermission is hereby granted..." + "file-content": "Attach the license that is being used for this project. For helping choosing a license, visit this website: https://choosealicense.com/ \n" } } }, @@ -131,7 +131,7 @@ "content": "Security and Responsible Disclosure Policy", "flags": "i", "file-name": "SECURITY.md", - "file-content": "\n## Security and Responsible Disclosure Policy\nDetails about security vulnerabilities and how to report them..." + "file-content": "The Centers for Medicare & Medicaid Services is committed to ensuring the security of the American public by protecting their information from unwarranted disclosure. We want security researchers to feel comfortable reporting vulnerabilities they have discovered so we can fix them and keep our users safe. We developed our disclosure policy to reflect our values and uphold our sense of responsibility to security researchers who share their expertise with us in good faith. \n *Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days. \n Review the HHS Disclosure Policy and websites in scope: \n [https://www.hhs.gov/vulnerability-disclosure-policy/index.html](https://www.hhs.gov/vulnerability-disclosure-policy/index.html). \n This policy describes *what systems and types of research* are covered under this policy, *how to send* us vulnerability reports, and *how long* we ask security researchers to wait before publicly disclosing vulnerabilities. \n" } } }, @@ -144,7 +144,7 @@ "content": "About the Project", "flags": "i", "file-name": "README.md", - "file-content": "\n## About the Project\nA description of the project's purpose and functionality..." + "file-content": "## About the Project\n \n" } } }, @@ -157,7 +157,7 @@ "content": "Project Vision", "flags": "i", "file-name": "README.md", - "file-content": "\n## Project Vision\nThe long-term goals and aspirations for this project..." + "file-content": "## Project Vision\n \n" } } }, @@ -170,7 +170,7 @@ "content": "Project Mission", "flags": "i", "file-name": "README.md", - "file-content": "\n## Project Mission\nThe core mission and objectives driving this project..." + "file-content": "## Project Mission\n \n" } } }, @@ -183,7 +183,7 @@ "content": "Agency Mission", "flags": "i", "file-name": "README.md", - "file-content": "\n## Agency Mission\nThe mission of our agency and how this project aligns..." + "file-content": "## Agency Mission\n \n" } } }, @@ -196,7 +196,7 @@ "content": "Team Mission", "flags": "i", "file-name": "README.md", - "file-content": "\n## Team Mission\nOur team's goals and how we work together..." + "file-content": "## Team Mission\n \n" } } }, @@ -209,7 +209,7 @@ "content": "Core Team", "flags": "i", "file-name": "README.md", - "file-content": "\n## Core Team\nKey members and contributors of the project..." + "file-content": "## Core Team\n 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. \n" } } }, @@ -222,7 +222,7 @@ "content": "Documentation Index", "flags": "i", "file-name": "README.md", - "file-content": "\n## Documentation Index\nLinks to all project documentation..." + "file-content": "## Documentation Index\n \n **{list of .md at top directory and descriptions}** \n" } } }, @@ -235,7 +235,7 @@ "content": "Repository Structure", "flags": "i", "file-name": "README.md", - "file-content": "\n## Repository Structure\nOverview of key directories and files..." + "file-content": "## Repository Structure\n \n \n **{list directories and descriptions}** \n" } } }, @@ -248,7 +248,7 @@ "content": "Development and Software Delivery Lifecycle", "flags": "i", "file-name": "README.md", - "file-content": "\n## Development and Software Delivery Lifecycle\nStages from development to deployment..." + "file-content": "## Development and Software Delivery Lifecycle\n 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 external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md). \n" } } }, @@ -261,7 +261,7 @@ "content": "Local Development", "flags": "i", "file-name": "README.md", - "file-content": "\n## Local Development\nSteps to set up and run the project locally..." + "file-content": "## Local Development\n \n" } } }, @@ -274,7 +274,7 @@ "content": "Coding Style and Linters", "flags": "i", "file-name": "README.md", - "file-content": "\n## Coding Style and Linters\nCoding standards and tools for maintaining code quality..." + "file-content": "## Coding Style and Linters\n \n 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. \n" } } }, @@ -287,7 +287,7 @@ "content": "Branching Model", "flags": "i", "file-name": "README.md", - "file-content": "\n## Branching Model\nGit workflow and branch naming conventions..." + "file-content": "## Branching Model\n \n" } } }, @@ -300,7 +300,7 @@ "content": "Contributing", "flags": "i", "file-name": "README.md", - "file-content": "\n## Contributing\nGuidelines for contributing to the project..." + "file-content": "## Contributing\n 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). \n" } } }, @@ -313,7 +313,7 @@ "content": "Codeowners", "flags": "i", "file-name": "README.md", - "file-content": "\n## Codeowners\nList of maintainers responsible for different parts..." + "file-content": "## Codeowners\n The contents of this repository are managed by **{responsible organization(s)}**. Those responsible for the code and documentation in this repository can be found in [CODEOWNERS.md](CODEOWNERS.md). \n" } } }, @@ -326,7 +326,7 @@ "content": "Community", "flags": "i", "file-name": "README.md", - "file-content": "\n## Community\nInformation about our community and how to get involved..." + "file-content": "## Community\n The {name_of_project_here} 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.\n\nWe 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.\n\nWe 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. \n" } } }, @@ -339,7 +339,7 @@ "content": "Community Guidelines", "flags": "i", "file-name": "README.md", - "file-content": "\n## Community Guidelines\nStandards for community interaction and behavior..." + "file-content": "## Community Guidelines\n 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. \n" } } }, @@ -352,7 +352,7 @@ "content": "Governance", "flags": "i", "file-name": "README.md", - "file-content": "\n## Governance\nProject governance structure and decision-making process..." + "file-content": "## Governance\n \nInformation about how the {{ cookiecutter.project_name }} community is governed may be found in [GOVERNANCE.md](GOVERNANCE.md). \n" } } }, @@ -365,7 +365,7 @@ "content": "Feedback", "flags": "i", "file-name": "README.md", - "file-content": "\n## Feedback\nHow to provide feedback and suggestions..." + "file-content": "## Feedback\n If you have ideas for how we can improve or add to our capacity building efforts and methods for welcoming people into our community, please let us know at **{contact_email}**. If you would like to comment on the tool itself, please let us know by filing an **issue on our GitHub repository.** \n" } } }, @@ -378,7 +378,7 @@ "content": "Glossary", "flags": "i", "file-name": "README.md", - "file-content": "\n## Glossary\nDefinitions of key terms and concepts..." + "file-content": "## Glossary\n Information about terminology and acronyms used in this documentation may be found in [GLOSSARY.md](GLOSSARY.md). \n" } } }, @@ -391,7 +391,7 @@ "content": "Policies", "flags": "i", "file-name": "README.md", - "file-content": "\n## Policies\nProject policies and guidelines..." + "file-content": "## Policies\n" } } }, @@ -404,7 +404,7 @@ "content": "Open Source Policy", "flags": "i", "file-name": "README.md", - "file-content": "\n## Open Source Policy\nGuidelines for open source contributions..." + "file-content": "### Open Source Policy\n 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:opensource@cms.hhs.gov). \n" } } }, @@ -417,7 +417,7 @@ "content": "Security and Responsible Disclosure Policy", "flags": "i", "file-name": "README.md", - "file-content": "\n## Security and Responsible Disclosure Policy\nHow to report..." + "file-content": "### Security and Responsible Disclosure Policy\n *Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.\nFor more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md). \n" } } }, @@ -430,7 +430,20 @@ "content": "Public domain", "flags": "i", "file-name": "README.md", - "file-content": "\n## Public Domain\nInformation about public domain status..." + "file-content": "## Public Domain\n 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).\nAll 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.\n" + } + } + }, + "readme-contains-sbom": { + "level": "error", + "rule": { + "type": "file-contents", + "options": { + "globsAll": ["README.md"], + "content": "Software Bill of Materials", + "flags": "i", + "file-name": "README.md", + "file-content": "### Software Bill of Materials (SBOM)\nA Software Bill of Materials (SBOM) is a formal record containing the details and supply chain relationships of various components used in building software.\nIn the spirit of [Executive Order 14028 - Improving the Nation's Cyber Security](https://www.gsa.gov/technology/it-contract-vehicles-and-purchasing-programs/information-technology-category/it-security/executive-order-14028), a SBOM for this repository is provided here: https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/network/dependencies.\nFor more information and resources about SBOMs, visit: https://www.cisa.gov/sbom." } } }, @@ -443,7 +456,7 @@ "content": "How to Contribute", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## How to Contribute\nSteps for making contributions to the project..." + "file-content": "# How to Contribute\n \nWe'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.\n \n We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md). \n" } } }, @@ -456,7 +469,7 @@ "content": "Getting Started", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Getting Started\nInitial setup steps for contributors..." + "file-content": "## Getting Started\n \n" } } }, @@ -469,7 +482,7 @@ "content": "Team Specific Guidelines", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Team Specific Guidelines\nTeam-specific contribution requirements..." + "file-content": "### Team Specific Guidelines\n \n" } } }, @@ -482,7 +495,7 @@ "content": "Building dependencies", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Building Dependencies\nSteps to build project dependencies..." + "file-content": "### Building Dependencies\n \n" } } }, @@ -495,7 +508,7 @@ "content": "Building the Project", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Building the Project\nSteps to build and test the project..." + "file-content": "### Building the Project\n \n" } } }, @@ -508,7 +521,7 @@ "content": "Workflow and Branching", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Workflow and Branching\nGit workflow guidelines and branch conventions..." + "file-content": "### Workflow and Branching\n \n" } } }, @@ -521,7 +534,7 @@ "content": "Testing Conventions", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Testing Conventions\nTesting requirements and guidelines..." + "file-content": "### Testing Conventions\n \n" } } }, @@ -534,7 +547,7 @@ "content": "Coding Style and Linters", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Coding Style and Linters\nCode formatting and linting requirements..." + "file-content": "### Coding Style and Linters\n \n" } } }, @@ -547,7 +560,7 @@ "content": "ISSUE_TEMPLATE.md | Issues", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Writing Issues\nGuidelines for creating effective issue reports..." + "file-content": "### Writing Issues\n \n" } } }, @@ -560,7 +573,7 @@ "content": "Writing Pull Requests", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Writing Pull Requests\nGuidelines for submitting pull requests..." + "file-content": "### Writing Pull Requests\n \n" } } }, @@ -573,7 +586,7 @@ "content": "Reviewing Pull Requests", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Reviewing Pull Requests\nGuidelines for reviewing contributions..." + "file-content": "### Reviewing Pull Requests\n \n" } } }, @@ -586,7 +599,7 @@ "content": "Shipping Releases", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Shipping Releases\nProcess for creating and publishing releases..." + "file-content": "## Shipping Releases\n \n" } } }, @@ -599,7 +612,7 @@ "content": "Documentation", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Documentation\nGuidelines for writing and updating documentation..." + "file-content": "## Documentation\n \n" } } }, @@ -612,7 +625,7 @@ "content": "Policies", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Policies\nProject policies for contributors..." + "file-content": "## Policies\n" } } }, @@ -625,7 +638,7 @@ "content": "Open Source Policy", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Open Source Policy\nOpen source guidelines and requirements..." + "file-content": "### Open Source Policy\n 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:opensource@cms.hhs.gov).\n" } } }, @@ -638,7 +651,7 @@ "content": "Security and Responsible Disclosure Policy", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Security and Responsible Disclosure Policy\nGuidelines for reporting security issues..." + "file-content": "### Security and Responsible Disclosure Policy\n *Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.\n For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md).\n" } } }, @@ -651,7 +664,7 @@ "content": "Public domain", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "\n## Public Domain\nInformation about public domain status..." + "file-content": "## Public Domain\n 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).\n 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.\n" } } }, @@ -664,7 +677,7 @@ "content": "Maintainers", "flags": "i", "file-name": "MAINTAINERS.md", - "file-content": "\n## Maintainers\nList of project maintainers and responsibilities..." + "file-content": "## Maintainers\n \n This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS.md) for list of reviewers for different parts of the codebase. Team members include:\n" } } }, @@ -677,7 +690,7 @@ "content": "Maintainers:", "flags": "i", "file-name": "MAINTAINERS.md", - "file-content": "\n## Maintainers:\nCurrent project maintainers and their roles..." + "file-content": "## Maintainers:\n\n - \n" } } }, @@ -690,7 +703,7 @@ "content": "Approvers:", "flags": "i", "file-name": "MAINTAINERS.md", - "file-content": "\n## Approvers:\nList of people who can approve changes..." + "file-content": "## Approvers:\n - \n" } } }, @@ -703,7 +716,7 @@ "content": "Reviewers:", "flags": "i", "file-name": "MAINTAINERS.md", - "file-content": "\n## Reviewers:\nList of designated code reviewers..." + "file-content": "## Reviewers:\n - \n\n| Roles | Responsibilities | Requirements | Defined by |\n| -------------|:-----------------------------------------|:-----------------------------------------------|:---------------------------------------|\n| member | active contributor in the community | multiple contributions to the project. | PROJECT GitHub org Committer Team |\n| reviewer | review contributions from other members | history of review and authorship in a sub-project | MAINTAINERS file reviewer entry, and GitHub Org Triage Team |\n| approver | approve accepting contributions | highly experienced and active reviewer + contributor to a sub-project | MAINTAINERS file approver entry and GitHub Triage Team |\n| lead | set direction and priorities for a sub-project | demonstrated responsibility and excellent technical judgement for the sub-project | MAINTAINERS file owner entry and GitHub Org Admin Team |\n" } } }, @@ -716,7 +729,7 @@ "content": "Governance", "flags": "i", "file-name": "GOVERNANCE.md", - "file-content": "\n## Governance\nProject governance structure and processes..." + "file-content": "#Governance \n \n This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). \n" } } }, @@ -729,7 +742,7 @@ "content": "Code Owners", "flags": "i", "file-name": "CODEOWNERS.md", - "file-content": "\n## Code Owners\nList of code owners and their areas..." + "file-content": "#Code Owners \n \n" } } }, @@ -742,7 +755,7 @@ "content": "documentation | frontend | backend | Repo Domains", "flags": "i", "file-name": "CODEOWNERS.md", - "file-content": "\n## Repository Domains\nBreakdown of different project areas..." + "file-content": "## Repository Domains\n \n" } } }, @@ -755,7 +768,7 @@ "content": "Principles", "flags": "i", "file-name": "COMMUNITY_GUIDELINES.md", - "file-content": "\n## Principles\nCore principles guiding our community..." + "file-content": "## Principles\n These principles guide our data, product, and process decisions, architecture, and approach.\n- Open means transparent and participatory.\n- We take a modular and modern approach to software development.\n- We build open-source software and open-source process.\n- We value ease of implementation.\n- Fostering community includes building capacity and making our software and processes accessible to participants with diverse backgrounds and skillsets.\n- Data (and data science) is as important as software and process. We build open data sets where possible.\n- We strive for transparency for algorithms and places we might be introducing bias. \n" } } }, @@ -768,7 +781,7 @@ "content": "Community Guidelines", "flags": "i", "file-name": "COMMUNITY_GUIDELINES.md", - "file-content": "\n## Community Guidelines\nRules and expectations for community members..." + "file-content": "## Community Guidelines\n All community members are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).\nInformation on contributing to this repository is available in our [Contributing file](CONTRIBUTING.md).\nWhen participating in {{ cookiecutter.project_name }} open source community conversations and spaces, we ask individuals to follow the following guidelines:\n- When joining a conversation for the first time, please introduce yourself by providing a brief intro that includes:\n - your related organization (if applicable)\n - your pronouns\n - your superpower, and how you hope to use it for {{ cookiecutter.project_name }}\n- Embrace a culture of learning, and educate each other. We are all entering this conversation from different starting points and with different backgrounds. There are no dumb questions.\n- Take space and give space. We strive to create an equitable environment in which all are welcome and able to participate. We hope individuals feel comfortable voicing their opinions and providing contributions and will do our best to recognize and make space for individuals who may be struggling to find space here. Likewise, we expect individuals to recognize when they are taking up significant space and take a step back to allow room for others.\n\n- Be respectful.\n- Default to positive. Assume others' contributions are legitimate and valuable and that they are made with good intention.\n" } } }, @@ -781,7 +794,7 @@ "content": "Acknowledgements", "flags": "i", "file-name": "COMMUNITY_GUIDELINES.md", - "file-content": "\n## Acknowledgements\nRecognition of community contributors..." + "file-content": "## Acknowledgements\n This COMMUNITY_GUIDELINES.md was originally forked from the [United States Digital Service](https://usds.gov) [Justice40](https://thejustice40.com) open source [repository](https://github.com/usds/justice40-tool), and we would like to acknowledge and thank the community for their contributions.\n" } } }, @@ -794,7 +807,7 @@ "content": "Contributor Code of Conduct", "flags": "i", "file-name": "CODE_OF_CONDUCT.md", - "file-content": "\n## Contributor Code of Conduct\nExpectations for contributor behavior..." + "file-content": "\n## Contributor Code of Conduct\n As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. \n We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity, expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion. \n Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. \n Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct. \n Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers at opensource@cms.hhs.gov. \n This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)" } } }, @@ -807,7 +820,7 @@ "content": "Acknowledgements", "flags": "i", "file-name": "CODE_OF_CONDUCT.md", - "file-content": "\n## Acknowledgements\nRecognition of code of conduct sources..." + "file-content": "\n## Acknowledgements\n This CODE_OF_CONDUCT.md was originally forked from the [United States Digital Service](https://usds.gov) [Justice40](https://thejustice40.com) open source [repository](https://github.com/usds/justice40-tool), and we would like to acknowledge and thank the community for their contributions." } } } From b7aed5d2243f8f20da806079c57daaf39b7d121f Mon Sep 17 00:00:00 2001 From: Sachin Panayil Date: Thu, 5 Dec 2024 17:31:07 -0500 Subject: [PATCH 3/6] small changes to config Signed-off-by: Sachin Panayil --- .../repolinter.json | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/tier1/{{cookiecutter.project_slug}}/repolinter.json b/tier1/{{cookiecutter.project_slug}}/repolinter.json index 417742e7..ec46c2df 100644 --- a/tier1/{{cookiecutter.project_slug}}/repolinter.json +++ b/tier1/{{cookiecutter.project_slug}}/repolinter.json @@ -15,7 +15,7 @@ "globsAny": ["{docs/,.github/,}LICENSE*"], "nocase": true, "file-name": "LICENSE", - "file-content": "#License \n Remove this line and attach the license that is being used for this project. For helping choosing a license, visit this website: https://choosealicense.com/ \n" + "file-content": "# License \n Remove this line and attach the license that is being used for this project. For helping choosing a license, visit this website: https://choosealicense.com/ \n" } } }, @@ -26,7 +26,7 @@ "options": { "globsAny": ["{docs/,.github/,}SECURITY.md"], "file-name": "SECURITY.md", - "file-content": "#Security and Responsible Disclosure Policy \n" + "file-content": "# Security and Responsible Disclosure Policy \n" } } }, @@ -38,7 +38,7 @@ "globsAny": ["README.md"], "nocase": true, "file-name": "README.md", - "file-content": "#Replace with Project Name \n" + "file-content": "# Replace with Project Name \n" } } }, @@ -50,7 +50,7 @@ "globsAny": ["{docs/,.github/,}CONTRIBUTING.md"], "nocase": true, "file-name": "CONTRIBUTING.md", - "file-content": "#How to Contribute \n \n 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. \n We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md). \n" + "file-content": "# How to Contribute \n \n 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. \n We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md). \n" } } }, @@ -61,7 +61,7 @@ "options": { "globsAny": ["{docs/,.github/,}MAINTAINERS.md"], "file-name": "MAINTAINERS.md", - "file-content": "#Maintainers \n \n This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS.md) for list of reviewers for different parts of the codebase. Team members include: \n" + "file-content": "# Maintainers \n \n This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS.md) for list of reviewers for different parts of the codebase. Team members include: \n" } } }, @@ -83,7 +83,7 @@ "options": { "globsAny": ["{docs/,.github/,}GOVERNANCE.md"], "file-name": "GOVERNANCE.md", - "file-content": "#Governance \n \n This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). \n" + "file-content": "# Governance \n \n This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). \n" } } }, @@ -94,7 +94,7 @@ "options": { "globsAny": ["{docs/,.github/,}COMMUNITY_GUIDELINES.md"], "file-name": "COMMUNITY_GUIDELINES.md", - "file-content": "#Open Source Community Guidelines \n This document contains principles and guidelines for participating in the {name_of_project_here} open source community. \n" + "file-content": "# Open Source Community Guidelines \n This document contains principles and guidelines for participating in the {name_of_project_here} open source community. \n" } } }, @@ -105,7 +105,7 @@ "options": { "globsAny": ["{docs/,.github/,}CODE_OF_CONDUCT.md"], "file-name": "CODE_OF_CONDUCT.md", - "file-content": "#Code of Conduct \n" + "file-content": "# Code of Conduct \n" } } }, @@ -131,7 +131,7 @@ "content": "Security and Responsible Disclosure Policy", "flags": "i", "file-name": "SECURITY.md", - "file-content": "The Centers for Medicare & Medicaid Services is committed to ensuring the security of the American public by protecting their information from unwarranted disclosure. We want security researchers to feel comfortable reporting vulnerabilities they have discovered so we can fix them and keep our users safe. We developed our disclosure policy to reflect our values and uphold our sense of responsibility to security researchers who share their expertise with us in good faith. \n *Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days. \n Review the HHS Disclosure Policy and websites in scope: \n [https://www.hhs.gov/vulnerability-disclosure-policy/index.html](https://www.hhs.gov/vulnerability-disclosure-policy/index.html). \n This policy describes *what systems and types of research* are covered under this policy, *how to send* us vulnerability reports, and *how long* we ask security researchers to wait before publicly disclosing vulnerabilities. \n" + "file-content": "The Centers for Medicare & Medicaid Services is committed to ensuring the security of the American public by protecting their information from unwarranted disclosure. We want security researchers to feel comfortable reporting vulnerabilities they have discovered so we can fix them and keep our users safe. We developed our disclosure policy to reflect our values and uphold our sense of responsibility to security researchers who share their expertise with us in good faith. \n \n *Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days. \n \n Review the HHS Disclosure Policy and websites in scope: \n [https://www.hhs.gov/vulnerability-disclosure-policy/index.html](https://www.hhs.gov/vulnerability-disclosure-policy/index.html). \n \n This policy describes *what systems and types of research* are covered under this policy, *how to send* us vulnerability reports, and *how long* we ask security researchers to wait before publicly disclosing vulnerabilities. \n" } } }, @@ -443,7 +443,7 @@ "content": "Software Bill of Materials", "flags": "i", "file-name": "README.md", - "file-content": "### Software Bill of Materials (SBOM)\nA Software Bill of Materials (SBOM) is a formal record containing the details and supply chain relationships of various components used in building software.\nIn the spirit of [Executive Order 14028 - Improving the Nation's Cyber Security](https://www.gsa.gov/technology/it-contract-vehicles-and-purchasing-programs/information-technology-category/it-security/executive-order-14028), a SBOM for this repository is provided here: https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/network/dependencies.\nFor more information and resources about SBOMs, visit: https://www.cisa.gov/sbom." + "file-content": "### Software Bill of Materials (SBOM)\nA Software Bill of Materials (SBOM) is a formal record containing the details and supply chain relationships of various components used in building software.\nIn the spirit of [Executive Order 14028 - Improving the Nation's Cyber Security](https://www.gsa.gov/technology/it-contract-vehicles-and-purchasing-programs/information-technology-category/it-security/executive-order-14028), a SBOM for this repository is provided here: https://github.com/{repo_org}/{repo_name}/network/dependencies.\nFor more information and resources about SBOMs, visit: https://www.cisa.gov/sbom." } } }, From 84f90c22aafa3efa98f6330e5198d74195c2fda8 Mon Sep 17 00:00:00 2001 From: Sachin Panayil Date: Tue, 10 Dec 2024 11:55:06 -0500 Subject: [PATCH 4/6] added requested config changes Signed-off-by: Sachin Panayil --- tier1/{{cookiecutter.project_slug}}/README.md | 10 +- .../repolinter.json | 124 +++++++++--------- 2 files changed, 69 insertions(+), 65 deletions(-) diff --git a/tier1/{{cookiecutter.project_slug}}/README.md b/tier1/{{cookiecutter.project_slug}}/README.md index a98ee545..449374ea 100644 --- a/tier1/{{cookiecutter.project_slug}}/README.md +++ b/tier1/{{cookiecutter.project_slug}}/README.md @@ -2,19 +2,23 @@ {{ cookiecutter.project_description }} ## About the Project + **{project statement}** +**{project mission}** +Provide the core mission and objectives driving this project.--> +TODO: Recommended to include since this is an agency-led project +Provide the mission of the agency and how this project aligns. --> +TODO: Recommended to include since this is an agency-led project +Provide the team's mission and how they work together. --> ## Core Team diff --git a/tier1/{{cookiecutter.project_slug}}/repolinter.json b/tier1/{{cookiecutter.project_slug}}/repolinter.json index ec46c2df..6cb291da 100644 --- a/tier1/{{cookiecutter.project_slug}}/repolinter.json +++ b/tier1/{{cookiecutter.project_slug}}/repolinter.json @@ -15,7 +15,7 @@ "globsAny": ["{docs/,.github/,}LICENSE*"], "nocase": true, "file-name": "LICENSE", - "file-content": "# License \n Remove this line and attach the license that is being used for this project. For helping choosing a license, visit this website: https://choosealicense.com/ \n" + "file-content": "" } } }, @@ -26,7 +26,7 @@ "options": { "globsAny": ["{docs/,.github/,}SECURITY.md"], "file-name": "SECURITY.md", - "file-content": "# Security and Responsible Disclosure Policy \n" + "file-content": "" } } }, @@ -38,7 +38,7 @@ "globsAny": ["README.md"], "nocase": true, "file-name": "README.md", - "file-content": "# Replace with Project Name \n" + "file-content": "# {name_of_project_here} \n \n" } } }, @@ -50,7 +50,7 @@ "globsAny": ["{docs/,.github/,}CONTRIBUTING.md"], "nocase": true, "file-name": "CONTRIBUTING.md", - "file-content": "# How to Contribute \n \n 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. \n We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md). \n" + "file-content": "# Contributing Guidelines \n \n" } } }, @@ -61,7 +61,7 @@ "options": { "globsAny": ["{docs/,.github/,}MAINTAINERS.md"], "file-name": "MAINTAINERS.md", - "file-content": "# Maintainers \n \n This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS.md) for list of reviewers for different parts of the codebase. Team members include: \n" + "file-content": "" } } }, @@ -72,7 +72,7 @@ "options": { "globsAny": ["{docs/,.github/,}CODEOWNERS.md"], "file-name": "CODEOWNERS.md", - "file-content": "#Code Owners \n \n" + "file-content": "" } } }, @@ -83,7 +83,7 @@ "options": { "globsAny": ["{docs/,.github/,}GOVERNANCE.md"], "file-name": "GOVERNANCE.md", - "file-content": "# Governance \n \n This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). \n" + "file-content": "" } } }, @@ -94,7 +94,7 @@ "options": { "globsAny": ["{docs/,.github/,}COMMUNITY_GUIDELINES.md"], "file-name": "COMMUNITY_GUIDELINES.md", - "file-content": "# Open Source Community Guidelines \n This document contains principles and guidelines for participating in the {name_of_project_here} open source community. \n" + "file-content": "# {name_of_project_here} Open Source Community Guidelines \nThis document contains principles and guidelines for participating in the {name_of_project_here} open source community. \n" } } }, @@ -105,7 +105,7 @@ "options": { "globsAny": ["{docs/,.github/,}CODE_OF_CONDUCT.md"], "file-name": "CODE_OF_CONDUCT.md", - "file-content": "# Code of Conduct \n" + "file-content": "" } } }, @@ -118,7 +118,7 @@ "content": "license", "flags": "i", "file-name": "LICENSE", - "file-content": "Attach the license that is being used for this project. For helping choosing a license, visit this website: https://choosealicense.com/ \n" + "file-content": "# License \nRemove this line and attach the license that is being used for this project. For helping choosing a license, visit this website: https://choosealicense.com/ \n" } } }, @@ -131,7 +131,7 @@ "content": "Security and Responsible Disclosure Policy", "flags": "i", "file-name": "SECURITY.md", - "file-content": "The Centers for Medicare & Medicaid Services is committed to ensuring the security of the American public by protecting their information from unwarranted disclosure. We want security researchers to feel comfortable reporting vulnerabilities they have discovered so we can fix them and keep our users safe. We developed our disclosure policy to reflect our values and uphold our sense of responsibility to security researchers who share their expertise with us in good faith. \n \n *Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days. \n \n Review the HHS Disclosure Policy and websites in scope: \n [https://www.hhs.gov/vulnerability-disclosure-policy/index.html](https://www.hhs.gov/vulnerability-disclosure-policy/index.html). \n \n This policy describes *what systems and types of research* are covered under this policy, *how to send* us vulnerability reports, and *how long* we ask security researchers to wait before publicly disclosing vulnerabilities. \n" + "file-content": "# Security and Responsible Disclosure Policy \nThe Centers for Medicare & Medicaid Services is committed to ensuring the security of the American public by protecting their information from unwarranted disclosure. We want security researchers to feel comfortable reporting vulnerabilities they have discovered so we can fix them and keep our users safe. We developed our disclosure policy to reflect our values and uphold our sense of responsibility to security researchers who share their expertise with us in good faith. \n \n *Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days. \n \n Review the HHS Disclosure Policy and websites in scope: \n [https://www.hhs.gov/vulnerability-disclosure-policy/index.html](https://www.hhs.gov/vulnerability-disclosure-policy/index.html). \n \n This policy describes *what systems and types of research* are covered under this policy, *how to send* us vulnerability reports, and *how long* we ask security researchers to wait before publicly disclosing vulnerabilities. \n" } } }, @@ -144,7 +144,7 @@ "content": "About the Project", "flags": "i", "file-name": "README.md", - "file-content": "## About the Project\n \n" + "file-content": "## About the Project \n \n" } } }, @@ -157,7 +157,7 @@ "content": "Project Vision", "flags": "i", "file-name": "README.md", - "file-content": "## Project Vision\n \n" + "file-content": "## Project Vision \n \n" } } }, @@ -170,7 +170,7 @@ "content": "Project Mission", "flags": "i", "file-name": "README.md", - "file-content": "## Project Mission\n \n" + "file-content": "## Project Mission \n \n" } } }, @@ -183,7 +183,7 @@ "content": "Agency Mission", "flags": "i", "file-name": "README.md", - "file-content": "## Agency Mission\n \n" + "file-content": "## Agency Mission \n \n" } } }, @@ -196,7 +196,7 @@ "content": "Team Mission", "flags": "i", "file-name": "README.md", - "file-content": "## Team Mission\n \n" + "file-content": "## Team Mission \n \n" } } }, @@ -209,7 +209,7 @@ "content": "Core Team", "flags": "i", "file-name": "README.md", - "file-content": "## Core Team\n 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. \n" + "file-content": "## Core Team \nAn 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. \n" } } }, @@ -222,7 +222,7 @@ "content": "Documentation Index", "flags": "i", "file-name": "README.md", - "file-content": "## Documentation Index\n \n **{list of .md at top directory and descriptions}** \n" + "file-content": "## Documentation Index \n \n **{list of .md at top directory and descriptions}** \n" } } }, @@ -235,7 +235,7 @@ "content": "Repository Structure", "flags": "i", "file-name": "README.md", - "file-content": "## Repository Structure\n \n \n **{list directories and descriptions}** \n" + "file-content": "## Repository Structure \n \n \n **{list directories and descriptions}** \n" } } }, @@ -248,7 +248,7 @@ "content": "Development and Software Delivery Lifecycle", "flags": "i", "file-name": "README.md", - "file-content": "## Development and Software Delivery Lifecycle\n 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 external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md). \n" + "file-content": "## Development and Software Delivery Lifecycle \nThe 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 external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contributing, see: [CONTRIBUTING.md](./CONTRIBUTING.md). \n" } } }, @@ -261,7 +261,7 @@ "content": "Local Development", "flags": "i", "file-name": "README.md", - "file-content": "## Local Development\n \n" + "file-content": "## Local Development \n \n" } } }, @@ -274,7 +274,7 @@ "content": "Coding Style and Linters", "flags": "i", "file-name": "README.md", - "file-content": "## Coding Style and Linters\n \n 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. \n" + "file-content": "## Coding Style and Linters \n \n 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. \n" } } }, @@ -287,7 +287,7 @@ "content": "Branching Model", "flags": "i", "file-name": "README.md", - "file-content": "## Branching Model\n \n" + "file-content": "## Branching Model \n \n" } } }, @@ -300,7 +300,7 @@ "content": "Contributing", "flags": "i", "file-name": "README.md", - "file-content": "## Contributing\n 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). \n" + "file-content": "## Contributing \nThank 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). \n" } } }, @@ -313,7 +313,7 @@ "content": "Codeowners", "flags": "i", "file-name": "README.md", - "file-content": "## Codeowners\n The contents of this repository are managed by **{responsible organization(s)}**. Those responsible for the code and documentation in this repository can be found in [CODEOWNERS.md](CODEOWNERS.md). \n" + "file-content": "## Codeowners \nThe contents of this repository are managed by **{responsible organization(s)}**. Those responsible for the code and documentation in this repository can be found in [CODEOWNERS.md](CODEOWNERS.md). \n" } } }, @@ -326,7 +326,7 @@ "content": "Community", "flags": "i", "file-name": "README.md", - "file-content": "## Community\n The {name_of_project_here} 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.\n\nWe 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.\n\nWe 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. \n" + "file-content": "## Community \nThe {name_of_project_here} 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.\n\nWe 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.\n\nWe 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. \n" } } }, @@ -339,7 +339,7 @@ "content": "Community Guidelines", "flags": "i", "file-name": "README.md", - "file-content": "## Community Guidelines\n 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. \n" + "file-content": "## Community Guidelines \nPrinciples 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. \n" } } }, @@ -352,7 +352,7 @@ "content": "Governance", "flags": "i", "file-name": "README.md", - "file-content": "## Governance\n \nInformation about how the {{ cookiecutter.project_name }} community is governed may be found in [GOVERNANCE.md](GOVERNANCE.md). \n" + "file-content": "## Governance \n\nInformation about how the {{ cookiecutter.project_name }} community is governed may be found in [GOVERNANCE.md](GOVERNANCE.md). \n" } } }, @@ -365,7 +365,7 @@ "content": "Feedback", "flags": "i", "file-name": "README.md", - "file-content": "## Feedback\n If you have ideas for how we can improve or add to our capacity building efforts and methods for welcoming people into our community, please let us know at **{contact_email}**. If you would like to comment on the tool itself, please let us know by filing an **issue on our GitHub repository.** \n" + "file-content": "## Feedback \nIf you have ideas for how we can improve or add to our capacity building efforts and methods for welcoming people into our community, please let us know at **{contact_email}**. If you would like to comment on the tool itself, please let us know by filing an **issue on our GitHub repository.** \n" } } }, @@ -378,7 +378,7 @@ "content": "Glossary", "flags": "i", "file-name": "README.md", - "file-content": "## Glossary\n Information about terminology and acronyms used in this documentation may be found in [GLOSSARY.md](GLOSSARY.md). \n" + "file-content": "## Glossary \nInformation about terminology and acronyms used in this documentation may be found in [GLOSSARY.md](GLOSSARY.md). \n" } } }, @@ -391,7 +391,7 @@ "content": "Policies", "flags": "i", "file-name": "README.md", - "file-content": "## Policies\n" + "file-content": "## Policies \n" } } }, @@ -404,7 +404,7 @@ "content": "Open Source Policy", "flags": "i", "file-name": "README.md", - "file-content": "### Open Source Policy\n 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:opensource@cms.hhs.gov). \n" + "file-content": "### Open Source Policy \nWe 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:opensource@cms.hhs.gov). \n" } } }, @@ -417,7 +417,7 @@ "content": "Security and Responsible Disclosure Policy", "flags": "i", "file-name": "README.md", - "file-content": "### Security and Responsible Disclosure Policy\n *Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.\nFor more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md). \n" + "file-content": "### Security and Responsible Disclosure Policy \n*Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.\nFor more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md). \n" } } }, @@ -430,7 +430,7 @@ "content": "Public domain", "flags": "i", "file-name": "README.md", - "file-content": "## Public Domain\n 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).\nAll 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.\n" + "file-content": "## Public Domain \nThis 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).\nAll 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.\n" } } }, @@ -443,7 +443,7 @@ "content": "Software Bill of Materials", "flags": "i", "file-name": "README.md", - "file-content": "### Software Bill of Materials (SBOM)\nA Software Bill of Materials (SBOM) is a formal record containing the details and supply chain relationships of various components used in building software.\nIn the spirit of [Executive Order 14028 - Improving the Nation's Cyber Security](https://www.gsa.gov/technology/it-contract-vehicles-and-purchasing-programs/information-technology-category/it-security/executive-order-14028), a SBOM for this repository is provided here: https://github.com/{repo_org}/{repo_name}/network/dependencies.\nFor more information and resources about SBOMs, visit: https://www.cisa.gov/sbom." + "file-content": "### Software Bill of Materials (SBOM) \nA Software Bill of Materials (SBOM) is a formal record containing the details and supply chain relationships of various components used in building software.\nIn the spirit of [Executive Order 14028 - Improving the Nation's Cyber Security](https://www.gsa.gov/technology/it-contract-vehicles-and-purchasing-programs/information-technology-category/it-security/executive-order-14028), a SBOM for this repository is provided here: https://github.com/{repo_org}/{repo_name}/network/dependencies.\nFor more information and resources about SBOMs, visit: https://www.cisa.gov/sbom." } } }, @@ -456,7 +456,7 @@ "content": "How to Contribute", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "# How to Contribute\n \nWe'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.\n \n We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md). \n" + "file-content": "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.\n \n We encourage you to read this project's CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md). \n" } } }, @@ -469,7 +469,7 @@ "content": "Getting Started", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "## Getting Started\n \n" + "file-content": "## Getting Started \n \n" } } }, @@ -482,7 +482,7 @@ "content": "Team Specific Guidelines", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "### Team Specific Guidelines\n \n" + "file-content": "### Team Specific Guidelines \n \n" } } }, @@ -495,7 +495,7 @@ "content": "Building dependencies", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "### Building Dependencies\n \n" + "file-content": "### Building Dependencies \n \n" } } }, @@ -508,7 +508,7 @@ "content": "Building the Project", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "### Building the Project\n \n" + "file-content": "### Building the Project \n\n" } } }, @@ -521,7 +521,7 @@ "content": "Workflow and Branching", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "### Workflow and Branching\n \n" + "file-content": "### Workflow and Branching \n\n" } } }, @@ -534,7 +534,7 @@ "content": "Testing Conventions", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "### Testing Conventions\n \n" + "file-content": "### Testing Conventions \n \n" } } }, @@ -547,7 +547,7 @@ "content": "Coding Style and Linters", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "### Coding Style and Linters\n \n" + "file-content": "### Coding Style and Linters \n \n" } } }, @@ -560,7 +560,7 @@ "content": "ISSUE_TEMPLATE.md | Issues", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "### Writing Issues\n \n" + "file-content": "### Writing Issues \n\n" } } }, @@ -573,7 +573,7 @@ "content": "Writing Pull Requests", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "### Writing Pull Requests\n \n" + "file-content": "### Writing Pull Requests \n\n" } } }, @@ -586,7 +586,7 @@ "content": "Reviewing Pull Requests", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "### Reviewing Pull Requests\n \n" + "file-content": "### Reviewing Pull Requests \n\n" } } }, @@ -599,7 +599,7 @@ "content": "Shipping Releases", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "## Shipping Releases\n \n" + "file-content": "## Shipping Releases \n \n" } } }, @@ -612,7 +612,7 @@ "content": "Documentation", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "## Documentation\n \n" + "file-content": "## Documentation \n \n" } } }, @@ -625,7 +625,7 @@ "content": "Policies", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "## Policies\n" + "file-content": "## Policies \n" } } }, @@ -638,7 +638,7 @@ "content": "Open Source Policy", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "### Open Source Policy\n 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:opensource@cms.hhs.gov).\n" + "file-content": "### Open Source Policy \nWe 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:opensource@cms.hhs.gov).\n" } } }, @@ -651,7 +651,7 @@ "content": "Security and Responsible Disclosure Policy", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "### Security and Responsible Disclosure Policy\n *Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.\n For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md).\n" + "file-content": "### Security and Responsible Disclosure Policy \n*Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.\n For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md).\n" } } }, @@ -664,7 +664,7 @@ "content": "Public domain", "flags": "i", "file-name": "CONTRIBUTING.md", - "file-content": "## Public Domain\n 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).\n 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.\n" + "file-content": "## Public Domain \nThis 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).\n 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.\n" } } }, @@ -677,7 +677,7 @@ "content": "Maintainers", "flags": "i", "file-name": "MAINTAINERS.md", - "file-content": "## Maintainers\n \n This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS.md) for list of reviewers for different parts of the codebase. Team members include:\n" + "file-content": "## Maintainers \n\n This is a list of maintainers for this project. See [CODEOWNERS.md](./CODEOWNERS.md) for list of reviewers for different parts of the codebase. Team members include:\n" } } }, @@ -687,10 +687,10 @@ "type": "file-contents", "options": { "globsAll": ["{docs/,.github/,}MAINTAINERS.md"], - "content": "Maintainers:", + "content": "Maintainers List:", "flags": "i", "file-name": "MAINTAINERS.md", - "file-content": "## Maintainers:\n\n - \n" + "file-content": "## Maintainers List: \n\n - \n" } } }, @@ -729,7 +729,7 @@ "content": "Governance", "flags": "i", "file-name": "GOVERNANCE.md", - "file-content": "#Governance \n \n This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). \n" + "file-content": "# Governance \n \n This project is governed by our [Community Guidelines](COMMUNITY_GUIDELINES.md) and [Code of Conduct](CODE_OF_CONDUCT.md). \n" } } }, @@ -742,7 +742,7 @@ "content": "Code Owners", "flags": "i", "file-name": "CODEOWNERS.md", - "file-content": "#Code Owners \n \n" + "file-content": "#Code Owners \n \n" } } }, @@ -768,7 +768,7 @@ "content": "Principles", "flags": "i", "file-name": "COMMUNITY_GUIDELINES.md", - "file-content": "## Principles\n These principles guide our data, product, and process decisions, architecture, and approach.\n- Open means transparent and participatory.\n- We take a modular and modern approach to software development.\n- We build open-source software and open-source process.\n- We value ease of implementation.\n- Fostering community includes building capacity and making our software and processes accessible to participants with diverse backgrounds and skillsets.\n- Data (and data science) is as important as software and process. We build open data sets where possible.\n- We strive for transparency for algorithms and places we might be introducing bias. \n" + "file-content": "## Principles \nThese principles guide our data, product, and process decisions, architecture, and approach.\n- Open means transparent and participatory.\n- We take a modular and modern approach to software development.\n- We build open-source software and open-source process.\n- We value ease of implementation.\n- Fostering community includes building capacity and making our software and processes accessible to participants with diverse backgrounds and skillsets.\n- Data (and data science) is as important as software and process. We build open data sets where possible.\n- We strive for transparency for algorithms and places we might be introducing bias. \n" } } }, @@ -781,7 +781,7 @@ "content": "Community Guidelines", "flags": "i", "file-name": "COMMUNITY_GUIDELINES.md", - "file-content": "## Community Guidelines\n All community members are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).\nInformation on contributing to this repository is available in our [Contributing file](CONTRIBUTING.md).\nWhen participating in {{ cookiecutter.project_name }} open source community conversations and spaces, we ask individuals to follow the following guidelines:\n- When joining a conversation for the first time, please introduce yourself by providing a brief intro that includes:\n - your related organization (if applicable)\n - your pronouns\n - your superpower, and how you hope to use it for {{ cookiecutter.project_name }}\n- Embrace a culture of learning, and educate each other. We are all entering this conversation from different starting points and with different backgrounds. There are no dumb questions.\n- Take space and give space. We strive to create an equitable environment in which all are welcome and able to participate. We hope individuals feel comfortable voicing their opinions and providing contributions and will do our best to recognize and make space for individuals who may be struggling to find space here. Likewise, we expect individuals to recognize when they are taking up significant space and take a step back to allow room for others.\n\n- Be respectful.\n- Default to positive. Assume others' contributions are legitimate and valuable and that they are made with good intention.\n" + "file-content": "## Community Guidelines \nAll community members are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).\nInformation on contributing to this repository is available in our [Contributing file](CONTRIBUTING.md).\nWhen participating in {{ cookiecutter.project_name }} open source community conversations and spaces, we ask individuals to follow the following guidelines:\n- When joining a conversation for the first time, please introduce yourself by providing a brief intro that includes:\n - your related organization (if applicable)\n - your pronouns\n - your superpower, and how you hope to use it for {{ cookiecutter.project_name }}\n- Embrace a culture of learning, and educate each other. We are all entering this conversation from different starting points and with different backgrounds. There are no dumb questions.\n- Take space and give space. We strive to create an equitable environment in which all are welcome and able to participate. We hope individuals feel comfortable voicing their opinions and providing contributions and will do our best to recognize and make space for individuals who may be struggling to find space here. Likewise, we expect individuals to recognize when they are taking up significant space and take a step back to allow room for others.\n\n- Be respectful.\n- Default to positive. Assume others' contributions are legitimate and valuable and that they are made with good intention.\n" } } }, @@ -794,7 +794,7 @@ "content": "Acknowledgements", "flags": "i", "file-name": "COMMUNITY_GUIDELINES.md", - "file-content": "## Acknowledgements\n This COMMUNITY_GUIDELINES.md was originally forked from the [United States Digital Service](https://usds.gov) [Justice40](https://thejustice40.com) open source [repository](https://github.com/usds/justice40-tool), and we would like to acknowledge and thank the community for their contributions.\n" + "file-content": "## Acknowledgements \nThis COMMUNITY_GUIDELINES.md was originally forked from the [United States Digital Service](https://usds.gov) [Justice40](https://thejustice40.com) open source [repository](https://github.com/usds/justice40-tool), and we would like to acknowledge and thank the community for their contributions.\n" } } }, @@ -807,7 +807,7 @@ "content": "Contributor Code of Conduct", "flags": "i", "file-name": "CODE_OF_CONDUCT.md", - "file-content": "\n## Contributor Code of Conduct\n As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. \n We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity, expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion. \n Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. \n Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct. \n Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers at opensource@cms.hhs.gov. \n This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)" + "file-content": "## Contributor Code of Conduct \nAs contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. \n We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity, expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion. \n Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. \n Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct. \n Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers at opensource@cms.hhs.gov. \n This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/) \n" } } }, @@ -820,7 +820,7 @@ "content": "Acknowledgements", "flags": "i", "file-name": "CODE_OF_CONDUCT.md", - "file-content": "\n## Acknowledgements\n This CODE_OF_CONDUCT.md was originally forked from the [United States Digital Service](https://usds.gov) [Justice40](https://thejustice40.com) open source [repository](https://github.com/usds/justice40-tool), and we would like to acknowledge and thank the community for their contributions." + "file-content": "## Acknowledgements \nThis CODE_OF_CONDUCT.md was originally forked from the [United States Digital Service](https://usds.gov) [Justice40](https://thejustice40.com) open source [repository](https://github.com/usds/justice40-tool), and we would like to acknowledge and thank the community for their contributions. \n" } } } From 0a425a7caed91ee96d84109fb0ed6d65ff3ee3f3 Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Thu, 19 Dec 2024 15:52:02 -0500 Subject: [PATCH 5/6] Created documentation for GH action workflows Signed-off-by: Natalia Luzuriaga --- .github/docs/workflows.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/docs/workflows.md diff --git a/.github/docs/workflows.md b/.github/docs/workflows.md new file mode 100644 index 00000000..51bbc95c --- /dev/null +++ b/.github/docs/workflows.md @@ -0,0 +1,11 @@ +## Workflows + +Located in .**github/workflows**, the OSPO has created GitHub Actions workflows to assist project teams with development and documentation upkeep for repository hygiene. + +| File Name | Tier | Description | +| :----------------- | :--------- | :------------------------------------------------- | +| auto-changelog.yml | 2, 3, 4 | Auto-generates a CHANGELOG.md | +| checks.yml | 1, 2, 3, 4 | Performs repolinter checks | +| contributors.yml | 2, 3, 4 | Generates a list of contributors in MAINTAINERS.md | +| gitleaks.yml | 1, 2, 3, 4 | Scans for secrets upon each push or PR | +| repoStructure.yml | 3, 4 | Generates repo structure in README.md | From 3e5a500bee852cebbf235dccc1250ef663fcf8d6 Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Thu, 19 Dec 2024 15:55:31 -0500 Subject: [PATCH 6/6] Added links to workflow files Signed-off-by: Natalia Luzuriaga --- .github/docs/workflows.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/docs/workflows.md b/.github/docs/workflows.md index 51bbc95c..343ca611 100644 --- a/.github/docs/workflows.md +++ b/.github/docs/workflows.md @@ -2,10 +2,10 @@ Located in .**github/workflows**, the OSPO has created GitHub Actions workflows to assist project teams with development and documentation upkeep for repository hygiene. -| File Name | Tier | Description | -| :----------------- | :--------- | :------------------------------------------------- | -| auto-changelog.yml | 2, 3, 4 | Auto-generates a CHANGELOG.md | -| checks.yml | 1, 2, 3, 4 | Performs repolinter checks | -| contributors.yml | 2, 3, 4 | Generates a list of contributors in MAINTAINERS.md | -| gitleaks.yml | 1, 2, 3, 4 | Scans for secrets upon each push or PR | -| repoStructure.yml | 3, 4 | Generates repo structure in README.md | +| File Name | Tier | Description | +| :--------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------- | :------------------------------------------------- | +| [auto-changelog.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/auto-changelog.yml) | 2, 3, 4 | Auto-generates a CHANGELOG.md | +| [checks.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/checks.yml) | 1, 2, 3, 4 | Performs repolinter checks | +| [contributors.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/contributors.yml) | 2, 3, 4 | Generates a list of contributors in MAINTAINERS.md | +| [gitleaks.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/gitleaks.yml) | 1, 2, 3, 4 | Scans for secrets upon each push or PR | +| [repoStructure.yml](https://github.com/DSACMS/repo-scaffolder/blob/main/tier3/%7B%7Bcookiecutter.project_slug%7D%7D/.github/workflows/repoStructure.yml) | 3, 4 | Generates repo structure in README.md |