From 8fa34f9565a3f8ff97c05a26b1eb24ad1c609289 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 31 Jan 2025 18:28:27 +0000 Subject: [PATCH 01/15] update contributors information --- MAINTAINERS.md | 115 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 115 insertions(+) diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 7fb0e3b..45f80fd 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -50,4 +50,119 @@ GitHub Actions Total number of contributors: + + + + + + + + + + + + + + + + + + + + + + + + +
+ + natalialuzuriaga +
+ Natalia Luzuriaga + + 		+ + IsaacMilarky +
+ Isaac Milarsky + + 		+ + aprilselby88 +
+ April + + 		+ + vantuyls +
+ Steve Van Tuyl + + 		+ + sachin-panayil +
+ Sachin Panayil + + 		+ + decause-gov +
+ decause-gov + +
+ + Firebird1029 +
+ Brandon Yee + + 		+ + JosephGasiorekUSDS +
+ JosephGasiorekUSDS + + 		+ + RicardoZamora01 +
+ Ricardo Zamora + + 		+ + satwic007 +
+ satwic007 + + 		+ + NoobNoob06 +
+ Keni + + 		+ + CreativeNick +
+ Nick + +
+ + sgarciahelguera +
+ Sebastián + + 		+ + jabirG +
+ Jabir Ghaffar + + 		+ + DinneK +
+ Dinne Kopelevich + +
From f4880a08c6ce226dc044295236b227fb8dc64844 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 31 Jan 2025 18:28:27 +0000 Subject: [PATCH 02/15] update contributors information --- MAINTAINERS.md | 115 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 115 insertions(+) diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 7fb0e3b..45f80fd 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -50,4 +50,119 @@ GitHub Actions Total number of contributors: + + + + + + + + + + + + + + + + + + + + + + + + +
+ + natalialuzuriaga +
+ Natalia Luzuriaga + + 		+ + IsaacMilarky +
+ Isaac Milarsky + + 		+ + aprilselby88 +
+ April + + 		+ + vantuyls +
+ Steve Van Tuyl + + 		+ + sachin-panayil +
+ Sachin Panayil + + 		+ + decause-gov +
+ decause-gov + +
+ + Firebird1029 +
+ Brandon Yee + + 		+ + JosephGasiorekUSDS +
+ JosephGasiorekUSDS + + 		+ + RicardoZamora01 +
+ Ricardo Zamora + + 		+ + satwic007 +
+ satwic007 + + 		+ + NoobNoob06 +
+ Keni + + 		+ + CreativeNick +
+ Nick + +
+ + sgarciahelguera +
+ Sebastián + + 		+ + jabirG +
+ Jabir Ghaffar + + 		+ + DinneK +
+ Dinne Kopelevich + +
From f66bebe5f183b2f346855b17b4c0636b84a88288 Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Fri, 31 Jan 2025 13:31:07 -0800 Subject: [PATCH 03/15] Fixed .git initalization bug Signed-off-by: Natalia Luzuriaga --- tier1/hooks/post_gen_project.py | 19 +++++++++++++------ tier2/hooks/post_gen_project.py | 19 +++++++++++++------ tier3/hooks/post_gen_project.py | 19 ++++++++++++------- tier4/hooks/post_gen_project.py | 19 +++++++++++++------ 4 files changed, 51 insertions(+), 25 deletions(-) diff --git a/tier1/hooks/post_gen_project.py b/tier1/hooks/post_gen_project.py index 1d7d65b..cf34b0f 100644 --- a/tier1/hooks/post_gen_project.py +++ b/tier1/hooks/post_gen_project.py @@ -30,14 +30,21 @@ def addTopic(): subprocess.call(gh_cli_command) def moveCookiecutterFile(): - github_dir = os.path.join(os.getcwd(), ".github") - os.chdir(github_dir) + original_dir = os.getcwd() - source_path = "cookiecutter.json" - destination_dir = "codejson" - destination_path = os.path.join(destination_dir, "cookiecutter.json") + try: + github_dir = os.path.join(original_dir, ".github") + os.chdir(github_dir) - shutil.move(source_path, destination_path) + source_path = "cookiecutter.json" + destination_dir = "codejson" + destination_path = os.path.join(destination_dir, "cookiecutter.json") + + shutil.move(source_path, destination_path) + + finally: + # Moves back to project dir + os.chdir(original_dir) def main(): moveCookiecutterFile() diff --git a/tier2/hooks/post_gen_project.py b/tier2/hooks/post_gen_project.py index 92861ff..a6aedf9 100644 --- a/tier2/hooks/post_gen_project.py +++ b/tier2/hooks/post_gen_project.py @@ -71,14 +71,21 @@ def addMaintainer(): f.write(line) def moveCookiecutterFile(): - github_dir = os.path.join(os.getcwd(), ".github") - os.chdir(github_dir) + original_dir = os.getcwd() - source_path = "cookiecutter.json" - destination_dir = "codejson" - destination_path = os.path.join(destination_dir, "cookiecutter.json") + try: + github_dir = os.path.join(original_dir, ".github") + os.chdir(github_dir) - shutil.move(source_path, destination_path) + source_path = "cookiecutter.json" + destination_dir = "codejson" + destination_path = os.path.join(destination_dir, "cookiecutter.json") + + shutil.move(source_path, destination_path) + + finally: + # Moves back to project dir + os.chdir(original_dir) def main(): if ADD_MAINTAINER == "True": diff --git a/tier3/hooks/post_gen_project.py b/tier3/hooks/post_gen_project.py index c3cf3e8..ab9ea36 100644 --- a/tier3/hooks/post_gen_project.py +++ b/tier3/hooks/post_gen_project.py @@ -64,16 +64,21 @@ def addMaintainer(): f.writelines(lines) def moveCookiecutterFile(): - github_dir = os.path.join(os.getcwd(), ".github") - os.chdir(github_dir) + original_dir = os.getcwd() - source_path = "cookiecutter.json" - destination_dir = "codejson" - destination_path = os.path.join(destination_dir, "cookiecutter.json") + try: + github_dir = os.path.join(original_dir, ".github") + os.chdir(github_dir) - shutil.move(source_path, destination_path) + source_path = "cookiecutter.json" + destination_dir = "codejson" + destination_path = os.path.join(destination_dir, "cookiecutter.json") - print("ALL DONEZO") + shutil.move(source_path, destination_path) + + finally: + # Moves back to project dir + os.chdir(original_dir) def main(): if ADD_MAINTAINER == "True": diff --git a/tier4/hooks/post_gen_project.py b/tier4/hooks/post_gen_project.py index eda1bcd..7c88a9f 100644 --- a/tier4/hooks/post_gen_project.py +++ b/tier4/hooks/post_gen_project.py @@ -64,14 +64,21 @@ def addMaintainer(): f.writelines(lines) def moveCookiecutterFile(): - github_dir = os.path.join(os.getcwd(), ".github") - os.chdir(github_dir) + original_dir = os.getcwd() - source_path = "cookiecutter.json" - destination_dir = "codejson" - destination_path = os.path.join(destination_dir, "cookiecutter.json") + try: + github_dir = os.path.join(original_dir, ".github") + os.chdir(github_dir) - shutil.move(source_path, destination_path) + source_path = "cookiecutter.json" + destination_dir = "codejson" + destination_path = os.path.join(destination_dir, "cookiecutter.json") + + shutil.move(source_path, destination_path) + + finally: + # Moves back to project dir + os.chdir(original_dir) def main(): if ADD_MAINTAINER == "True": From da0669ce3545f0f08e7c077b8619a5771232911d Mon Sep 17 00:00:00 2001 From: Sachin Panayil Date: Mon, 10 Feb 2025 14:21:40 -0500 Subject: [PATCH 04/15] fixed typo in repolinter config Signed-off-by: Sachin Panayil --- tier1/{{cookiecutter.project_slug}}/repolinter.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tier1/{{cookiecutter.project_slug}}/repolinter.json b/tier1/{{cookiecutter.project_slug}}/repolinter.json index ebddbc0..5b02fe9 100644 --- a/tier1/{{cookiecutter.project_slug}}/repolinter.json +++ b/tier1/{{cookiecutter.project_slug}}/repolinter.json @@ -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" } } }, From 4de956b16e06b2fd8e9b2d6cb0bf14c16342f6f4 Mon Sep 17 00:00:00 2001 From: Sachin Panayil Date: Mon, 10 Feb 2025 14:51:15 -0500 Subject: [PATCH 05/15] added code.json workflow Signed-off-by: Sachin Panayil --- .github/workflows/updateCodeJSON.yml | 34 ++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/workflows/updateCodeJSON.yml diff --git a/.github/workflows/updateCodeJSON.yml b/.github/workflows/updateCodeJSON.yml new file mode 100644 index 0000000..fff52c6 --- /dev/null +++ b/.github/workflows/updateCodeJSON.yml @@ -0,0 +1,34 @@ +name: Update Code.json +on: + workflow_dispatch: + +permissions: + contents: write + pull-requests: write + +jobs: + update-code-json: + runs-on: ubuntu-latest + steps: + - name: Checkout Repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '20' + + - name: Setup Go + uses: actions/setup-go@v5 + with: + go-version: '1.22' + + - name: Install SCC + run: go install github.com/boyter/scc/v3@latest + + - name: Update code.json + uses: DSACMS/automated-codejson-generator@main + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file From 4465f2bbdcac182c2bbfae51f8e1531a7eeaa650 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 10 Feb 2025 19:52:19 +0000 Subject: [PATCH 06/15] Update code.json metadata --- code.json | 53 +++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 45 insertions(+), 8 deletions(-) diff --git a/code.json b/code.json index ba78aa0..25989a4 100644 --- a/code.json +++ b/code.json @@ -1,10 +1,47 @@ { - "projectType": "Tools", - "userInput": "No", - "fismaLevel": "Low", - "group": "CMS/OA/DSAC", - "subsetInHealthcare": "Operational", - "userType": "Government", - "repositoryHost": "Github.com", - "maturityModelTier": "3" + "name": "repo-scaffolder", + "description": "Templates and commandline tools for creating repositories for US Federal open source projects ", + "longDescription": "", + "status": "", + "permissions": { + "license": [ + { + "name": "", + "URL": "" + } + ], + "usageType": "", + "exemptionText": "" + }, + "organization": "", + "repositoryURL": "https://github.com/DSACMS/repo-scaffolder", + "vcs": "git", + "laborHours": 5940, + "platforms": [], + "categories": [], + "softwareType": "", + "languages": [ + "Python" + ], + "maintenance": "", + "date": { + "created": "2023-10-05T18:06:51Z", + "lastModified": "2025-02-10T19:51:24Z", + "metaDataLastUpdated": "2025-02-10T19:52:18.683Z" + }, + "tags": [], + "contact": { + "email": "", + "name": "" + }, + "localisation": false, + "repositoryType": "", + "userInput": "No", + "fismaLevel": "Low", + "group": "CMS/OA/DSAC", + "subsetInHealthcare": "Operational", + "userType": "Government", + "repositoryHost": "Github.com", + "maturityModelTier": "3", + "projectType": "Tools" } \ No newline at end of file From f77948817570c29e8c55044960c8e3a7aa279312 Mon Sep 17 00:00:00 2001 From: Sachin Panayil <79382140+sachin-panayil@users.noreply.github.com> Date: Mon, 10 Feb 2025 17:03:57 -0500 Subject: [PATCH 07/15] manual inputs --- code.json | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/code.json b/code.json index 25989a4..f5bd5d6 100644 --- a/code.json +++ b/code.json @@ -1,41 +1,41 @@ { "name": "repo-scaffolder", "description": "Templates and commandline tools for creating repositories for US Federal open source projects ", - "longDescription": "", - "status": "", + "longDescription": "repo-scaffolder assists project teams with creating repositories that adhere to repository hygiene standards. It provides file templates detailing project information, contributing guidance, maintainer roles, project metadata, community involvement, feedback mechanisms, governance, security policies, and more. ", + "status": "Production", "permissions": { "license": [ { - "name": "", - "URL": "" + "name": "CC0 1.0 Universal", + "URL": "https://github.com/DSACMS/repo-scaffolder/blob/main/LICENSE" } ], - "usageType": "", + "usageType": "openSource", "exemptionText": "" }, - "organization": "", + "organization": "Centers for Medicare & Medicaid Services", "repositoryURL": "https://github.com/DSACMS/repo-scaffolder", "vcs": "git", "laborHours": 5940, - "platforms": [], - "categories": [], - "softwareType": "", + "platforms": ["web", "windows", "mac", "linux"], + "categories": ["data-collection", "it-asset-management", "knowledge-management"], + "softwareType": "standalone/backend", "languages": [ "Python" ], - "maintenance": "", + "maintenance": "internal", "date": { "created": "2023-10-05T18:06:51Z", "lastModified": "2025-02-10T19:51:24Z", "metaDataLastUpdated": "2025-02-10T19:52:18.683Z" }, - "tags": [], + "tags": ["repository", "codejson", "cookiecutter"], "contact": { - "email": "", - "name": "" + "email": "opensource@cms.hhs.gov", + "name": "CMS Open Source Team" }, "localisation": false, - "repositoryType": "", + "repositoryType": "tools", "userInput": "No", "fismaLevel": "Low", "group": "CMS/OA/DSAC", @@ -44,4 +44,4 @@ "repositoryHost": "Github.com", "maturityModelTier": "3", "projectType": "Tools" -} \ No newline at end of file +} From 96dd8a10240d119d990709b8cc443c81797edd7e Mon Sep 17 00:00:00 2001 From: Sachin Panayil <79382140+sachin-panayil@users.noreply.github.com> Date: Tue, 11 Feb 2025 12:03:34 -0500 Subject: [PATCH 08/15] Update code.json --- code.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/code.json b/code.json index f5bd5d6..415b14c 100644 --- a/code.json +++ b/code.json @@ -36,12 +36,12 @@ }, "localisation": false, "repositoryType": "tools", - "userInput": "No", + "userInput": false, "fismaLevel": "Low", "group": "CMS/OA/DSAC", "subsetInHealthcare": "Operational", "userType": "Government", - "repositoryHost": "Github.com", - "maturityModelTier": "3", + "repositoryHost": "github.com/DSACMS", + "maturityModelTier": 3, "projectType": "Tools" } From 9bfbb15ff922eabae8c40926ceaf4f747a52671f Mon Sep 17 00:00:00 2001 From: Isaac Milarsky Date: Wed, 12 Feb 2025 11:52:37 -0600 Subject: [PATCH 09/15] Update CONTRIBUTING.md to include MAINTAINERS.md link Add link to MAINTAINERS.md file in CONTRIBUTING.md --- tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md index 6d4fd0d..bb4800a 100644 --- a/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -153,6 +153,9 @@ authorship metadata will be preserved. ## Shipping Releases +Our general policy for shipping releases can be found in our [MAINTAINERS.md](./MAINTAINERS.md) file. +We adhere to semantic versioning and automatic generation of changelogs +as described in this file. @@ -182,4 +185,4 @@ For more information about our Security, Vulnerability, and Responsible Disclosu This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/) as indicated in [LICENSE](LICENSE). -All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest. \ No newline at end of file +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. From e1f7b6e1300d3d3886eb6d5221e94e17559792a6 Mon Sep 17 00:00:00 2001 From: Isaac Milarsky Date: Wed, 12 Feb 2025 11:55:47 -0600 Subject: [PATCH 10/15] add to other tiers Signed-off-by: Isaac Milarsky --- tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md | 5 +++++ tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md | 3 +++ 2 files changed, 8 insertions(+) diff --git a/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md index 947d4f6..0c11395 100644 --- a/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -157,6 +157,11 @@ authorship metadata will be preserved. diff --git a/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md index 4a5c79f..0b21de0 100644 --- a/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -152,6 +152,9 @@ authorship metadata will be preserved. From 08b75fd01c90b7a013ddef35372be12baed9621c Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Fri, 21 Feb 2025 14:06:25 -0800 Subject: [PATCH 11/15] Updated CONTRIBUTING.md to include release guidance Signed-off-by: Natalia Luzuriaga --- tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md | 7 ++++--- tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md | 7 +++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md index 0b21de0..e2c3055 100644 --- a/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -152,11 +152,12 @@ authorship metadata will be preserved. ## Documentation @@ -177,7 +178,7 @@ questions, just [shoot us an email](mailto:opensource@cms.hhs.gov). ### Security and Responsible Disclosure Policy -*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. +_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. For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md). diff --git a/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md index bb4800a..c232b17 100644 --- a/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -150,14 +150,13 @@ authorship metadata will be preserved. --> - ## Shipping Releases Our general policy for shipping releases can be found in our [MAINTAINERS.md](./MAINTAINERS.md) file. We adhere to semantic versioning and automatic generation of changelogs -as described in this file. - +as described in this file. + ## Documentation @@ -177,7 +176,7 @@ questions, just [shoot us an email](mailto:opensource@cms.hhs.gov). ### Security and Responsible Disclosure Policy -*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. +_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. For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md). From 07b0e481f873924a98fee0b75380470fbf6fcb31 Mon Sep 17 00:00:00 2001 From: Natalia Luzuriaga Date: Tue, 25 Feb 2025 14:53:08 -0800 Subject: [PATCH 12/15] Added issue templates and guidance in tier 1 Signed-off-by: Natalia Luzuriaga --- .../.github/ISSUE_TEMPLATE/issue_report.md | 23 +++++++++++++++++++ .../CONTRIBUTING.md | 21 +++++++++-------- 2 files changed, 34 insertions(+), 10 deletions(-) create mode 100644 tier1/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/issue_report.md diff --git a/tier1/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/issue_report.md b/tier1/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/issue_report.md new file mode 100644 index 0000000..e170289 --- /dev/null +++ b/tier1/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/issue_report.md @@ -0,0 +1,23 @@ +--- +name: Issue report +about: Create an issue to help us improve +title: "" +labels: "" +assignees: "" +--- + +## Issue Report + +module-name: One line summary of the issue (less than 72 characters) + +### Expected behavior + +As concisely as possible, describe the expected behavior. + +### Actual behavior + +As concisely as possible, describe the observed behavior. + +### Steps to reproduce the behavior + +List all relevant steps to reproduce the observed behavior. diff --git a/tier1/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier1/{{cookiecutter.project_slug}}/CONTRIBUTING.md index e5bb6ca..6312c4e 100644 --- a/tier1/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier1/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -32,29 +32,29 @@ We encourage you to read this project's CONTRIBUTING policy (you are here), its TODO: Workflow Example We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow/) -1. Fork the project -2. Check out the `main` branch +1. Fork the project +2. Check out the `main` branch 3. Create a feature branch -4. Write code and tests for your change +4. Write code and tests for your change 5. From your branch, make a pull request against `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main` -6. Work with repo maintainers to get your change reviewed +6. Work with repo maintainers to get your change reviewed 7. Wait for your change to be pulled into `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main` 8. Delete your feature branch --> - @@ -62,7 +62,8 @@ TODO: Code Style Guide ### Issues + +## module-name: One line description of your change (less than 72 characters) + +## Problem + +Explain the context and why you're making that change. What is the problem +you're trying to solve? In some cases there is not a problem and this can be +thought of being the motivation for your change. + +## Solution + +Describe the modifications you've done. + +## Result + +What will change as a result of your pull request? Note that sometimes this +section is unnecessary because it is self-explanatory based on the solution. + +Some important notes regarding the summary line: + +- Describe what was done; not the result +- Use the active voice +- Use the present tense +- Capitalize properly +- Do not end in a period — this is a title/subject +- Prefix the subject with its scope + +## Test Plan + +(Write your test plan here. If you changed any code, please provide us with +clear instructions on how you verified your changes work.) diff --git a/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md index 0c11395..c4a5be0 100644 --- a/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier2/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -18,10 +18,10 @@ We encourage you to read this project's CONTRIBUTING policy (you are here), its - ### Building dependencies @@ -37,20 +37,20 @@ TODO: This section helps contributors understand any team structure in the proje - ### Coding Style and Linters @@ -58,7 +58,7 @@ TODO: Discuss where tests can be found, how they are run, and what kind of tests @@ -66,7 +66,8 @@ TODO: Discuss where tests can be found, how they are run, and what kind of tests ### Writing Issues - - - + +## module-name: One line description of your change (less than 72 characters) + +## Problem + +Explain the context and why you're making that change. What is the problem +you're trying to solve? In some cases there is not a problem and this can be +thought of being the motivation for your change. + +## Solution + +Describe the modifications you've done. + +## Result + +What will change as a result of your pull request? Note that sometimes this +section is unnecessary because it is self-explanatory based on the solution. + +Some important notes regarding the summary line: + +- Describe what was done; not the result +- Use the active voice +- Use the present tense +- Capitalize properly +- Do not end in a period — this is a title/subject +- Prefix the subject with its scope + +## Test Plan + +(Write your test plan here. If you changed any code, please provide us with +clear instructions on how you verified your changes work.) diff --git a/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md index e2c3055..906c2b4 100644 --- a/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier3/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -61,7 +61,7 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow ### Writing Issues - - - - - - - - - \ No newline at end of file +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. +--> diff --git a/tier1/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier1/{{cookiecutter.project_slug}}/CONTRIBUTING.md index 8becf61..36df85f 100644 --- a/tier1/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier1/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -78,8 +78,6 @@ When creating an issue please try to adhere to the following format: ### Steps to reproduce the behavior List all relevant steps to reproduce the observed behavior. - - see our .github/ISSUE_TEMPLATE.md for more examples. --> ### Writing Pull Requests @@ -120,7 +119,6 @@ Some important notes regarding the summary line: * Do not end in a period — this is a title/subject * Prefix the subject with its scope - see our .github/PULL_REQUEST_TEMPLATE.md for more examples. --> ## Reviewing Pull Requests diff --git a/tier4/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/issue_report.md b/tier4/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/issue_report.md new file mode 100644 index 0000000..e170289 --- /dev/null +++ b/tier4/{{cookiecutter.project_slug}}/.github/ISSUE_TEMPLATE/issue_report.md @@ -0,0 +1,23 @@ +--- +name: Issue report +about: Create an issue to help us improve +title: "" +labels: "" +assignees: "" +--- + +## Issue Report + +module-name: One line summary of the issue (less than 72 characters) + +### Expected behavior + +As concisely as possible, describe the expected behavior. + +### Actual behavior + +As concisely as possible, describe the observed behavior. + +### Steps to reproduce the behavior + +List all relevant steps to reproduce the observed behavior. diff --git a/tier4/{{cookiecutter.project_slug}}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/tier4/{{cookiecutter.project_slug}}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..1fcf8cf --- /dev/null +++ b/tier4/{{cookiecutter.project_slug}}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,42 @@ + + +## module-name: One line description of your change (less than 72 characters) + +## Problem + +Explain the context and why you're making that change. What is the problem +you're trying to solve? In some cases there is not a problem and this can be +thought of being the motivation for your change. + +## Solution + +Describe the modifications you've done. + +## Result + +What will change as a result of your pull request? Note that sometimes this +section is unnecessary because it is self-explanatory based on the solution. + +Some important notes regarding the summary line: + +- Describe what was done; not the result +- Use the active voice +- Use the present tense +- Capitalize properly +- Do not end in a period — this is a title/subject +- Prefix the subject with its scope + +## Test Plan + +(Write your test plan here. If you changed any code, please provide us with +clear instructions on how you verified your changes work.) diff --git a/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md b/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md index c232b17..588b98f 100644 --- a/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md +++ b/tier4/{{cookiecutter.project_slug}}/CONTRIBUTING.md @@ -61,7 +61,7 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow ### Writing Issues - ### Writing Pull Requests - ## Reviewing Pull Requests