Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Templates: Added issue & pr templates to all tiers #258

Merged
merged 21 commits into from
Feb 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
5966479
Merge pull request #242 from DSACMS/dev
sachin-panayil Jan 31, 2025
8fa34f9
update contributors information
github-actions[bot] Jan 31, 2025
f810daa
Merge pull request #248 from DSACMS/contributors-readme-action-FNE6AG…
sachin-panayil Jan 31, 2025
f4880a0
update contributors information
github-actions[bot] Jan 31, 2025
f66bebe
Fixed .git initalization bug
natalialuzuriaga Jan 31, 2025
ffbccc8
Merge pull request #250 from DSACMS/nat/cookiecutter-bug
natalialuzuriaga Feb 4, 2025
da0669c
fixed typo in repolinter config
sachin-panayil Feb 10, 2025
4de956b
added code.json workflow
sachin-panayil Feb 10, 2025
0c79795
Merge pull request #252 from DSACMS/sachin/configFix
sachin-panayil Feb 10, 2025
4465f2b
Update code.json metadata
github-actions[bot] Feb 10, 2025
f779488
manual inputs
sachin-panayil Feb 10, 2025
96dd8a1
Update code.json
sachin-panayil Feb 11, 2025
9bfbb15
Update CONTRIBUTING.md to include MAINTAINERS.md link
IsaacMilarky Feb 12, 2025
e1f7b6e
add to other tiers
IsaacMilarky Feb 12, 2025
ca6a8e4
Merge pull request #253 from DSACMS/code-json-1739217138689
sachin-panayil Feb 13, 2025
08b75fd
Updated CONTRIBUTING.md to include release guidance
natalialuzuriaga Feb 21, 2025
4715651
Merge pull request #254 from DSACMS/IsaacMilarky-patch-1
natalialuzuriaga Feb 24, 2025
07b0e48
Added issue templates and guidance in tier 1
natalialuzuriaga Feb 25, 2025
6c76b43
Added issue and pr templates to tier 2
natalialuzuriaga Feb 25, 2025
953192b
Added issue and pull request templates to tier 3
natalialuzuriaga Feb 25, 2025
6c52bf1
Added issue and pull request templates to tier 4
natalialuzuriaga Feb 25, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/updateCodeJSON.yml
Original file line number Diff line number Diff line change
@@ -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 }}
2 changes: 0 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,6 @@ When creating an issue please try to adhere to the following format:

List all relevant steps to reproduce the observed behavior.

see our .github/ISSUE_TEMPLATE.md for more examples.

### Writing Pull Requests

Comments should be formatted to a width no greater than 80 columns.
Expand Down
115 changes: 115 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,119 @@ GitHub Actions
Total number of contributors: <!--CONTRIBUTOR COUNT START--> <!--CONTRIBUTOR COUNT END-->

<!-- readme: contributors -start -->
<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/natalialuzuriaga">
<img src="https://avatars.githubusercontent.com/u/29980737?v=4" width="100;" alt="natalialuzuriaga"/>
<br />
<sub><b>Natalia Luzuriaga</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/IsaacMilarky">
<img src="https://avatars.githubusercontent.com/u/24639268?v=4" width="100;" alt="IsaacMilarky"/>
<br />
<sub><b>Isaac Milarsky</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/aprilselby88">
<img src="https://avatars.githubusercontent.com/u/143460853?v=4" width="100;" alt="aprilselby88"/>
<br />
<sub><b>April</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/vantuyls">
<img src="https://avatars.githubusercontent.com/u/9534576?v=4" width="100;" alt="vantuyls"/>
<br />
<sub><b>Steve Van Tuyl</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/sachin-panayil">
<img src="https://avatars.githubusercontent.com/u/79382140?v=4" width="100;" alt="sachin-panayil"/>
<br />
<sub><b>Sachin Panayil</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/decause-gov">
<img src="https://avatars.githubusercontent.com/u/107957201?v=4" width="100;" alt="decause-gov"/>
<br />
<sub><b>decause-gov</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/Firebird1029">
<img src="https://avatars.githubusercontent.com/u/6111102?v=4" width="100;" alt="Firebird1029"/>
<br />
<sub><b>Brandon Yee</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/JosephGasiorekUSDS">
<img src="https://avatars.githubusercontent.com/u/169079684?v=4" width="100;" alt="JosephGasiorekUSDS"/>
<br />
<sub><b>JosephGasiorekUSDS</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/RicardoZamora01">
<img src="https://avatars.githubusercontent.com/u/41018905?v=4" width="100;" alt="RicardoZamora01"/>
<br />
<sub><b>Ricardo Zamora</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/satwic007">
<img src="https://avatars.githubusercontent.com/u/26257975?v=4" width="100;" alt="satwic007"/>
<br />
<sub><b>satwic007</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/NoobNoob06">
<img src="https://avatars.githubusercontent.com/u/108984067?v=4" width="100;" alt="NoobNoob06"/>
<br />
<sub><b>Keni</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/CreativeNick">
<img src="https://avatars.githubusercontent.com/u/43157506?v=4" width="100;" alt="CreativeNick"/>
<br />
<sub><b>Nick</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/sgarciahelguera">
<img src="https://avatars.githubusercontent.com/u/9489918?v=4" width="100;" alt="sgarciahelguera"/>
<br />
<sub><b>Sebastián</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/jabirG">
<img src="https://avatars.githubusercontent.com/u/109629269?v=4" width="100;" alt="jabirG"/>
<br />
<sub><b>Jabir Ghaffar</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/DinneK">
<img src="https://avatars.githubusercontent.com/u/63877492?v=4" width="100;" alt="DinneK"/>
<br />
<sub><b>Dinne Kopelevich</b></sub>
</a>
</td>
</tr>
<tbody>
</table>
<!-- readme: contributors -end -->
55 changes: 46 additions & 9 deletions code.json
Original file line number Diff line number Diff line change
@@ -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": "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": "CC0 1.0 Universal",
"URL": "https://github.com/DSACMS/repo-scaffolder/blob/main/LICENSE"
}
],
"usageType": "openSource",
"exemptionText": ""
},
"organization": "Centers for Medicare & Medicaid Services",
"repositoryURL": "https://github.com/DSACMS/repo-scaffolder",
"vcs": "git",
"laborHours": 5940,
"platforms": ["web", "windows", "mac", "linux"],
"categories": ["data-collection", "it-asset-management", "knowledge-management"],
"softwareType": "standalone/backend",
"languages": [
"Python"
],
"maintenance": "internal",
"date": {
"created": "2023-10-05T18:06:51Z",
"lastModified": "2025-02-10T19:51:24Z",
"metaDataLastUpdated": "2025-02-10T19:52:18.683Z"
},
"tags": ["repository", "codejson", "cookiecutter"],
"contact": {
"email": "[email protected]",
"name": "CMS Open Source Team"
},
"localisation": false,
"repositoryType": "tools",
"userInput": false,
"fismaLevel": "Low",
"group": "CMS/OA/DSAC",
"subsetInHealthcare": "Operational",
"userType": "Government",
"repositoryHost": "github.com/DSACMS",
"maturityModelTier": 3,
"projectType": "Tools"
}
50 changes: 24 additions & 26 deletions tier0/{{cookiecutter.project_slug}}/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!--- # NOTE: Modify sections marked with `TODO` -->

<!--
<!--
# How to Contribute

We're so thankful you're considering contributing to an [open source project of
Expand All @@ -12,16 +12,16 @@ contributions.
We encourage you to read this project's CONTRIBUTING policy (you are here), its
[LICENSE](LICENSE.md), and its [README](README.md). -->

<!--
<!--
## Getting Started
TODO: If you have 'good-first-issue' or 'easy' labels for newcomers, mention them here. -->

<!--
### Building dependencies
<!--
### Building dependencies
TODO: This step is often skipped, so don't forget to include the steps needed to install on your platform. If you project can be multi-platform, this is an excellent place for first time contributors to send patches! -->

<!--
### Building the Project
<!--
### Building the Project
TODO: Be sure to include build scripts and instructions, not just the source code itself! -->

<!--
Expand All @@ -30,55 +30,53 @@ TODO: Be sure to include build scripts and instructions, not just the source cod
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
-->

<!--
<!--
### Testing Conventions

TODO: Discuss where tests can be found, how they are run, and what kind of tests/coverage strategy and goals the project has.
TODO: Discuss where tests can be found, how they are run, and what kind of tests/coverage strategy and goals the project has.
-->

<!--
### Coding Style and Linters

TODO: Code Style Guide
TODO: Code Style Guide

1. Mention any style guides you adhere to (e.g. pep8, etc...)
2. Mention any linters your project uses (e.g. flake8, jslint, etc...)
2. Mention any linters your project uses (e.g. flake8, jslint, etc...)
3. Mention any naming conventions your project uses (e.g. Semantic Versioning, CamelCasing, etc...)
4. Mention any other content guidelines the project adheres to (e.g. plainlanguage.gov, etc...)
-->

<!--
<!--
### Issues

TODO: Example Issue Guides

> When creating an issue please try to adhere to the following format:
>
>
> 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.
>
> see our .github/ISSUE_TEMPLATE.md for more examples.
-->

<!--
Expand All @@ -90,7 +88,7 @@ We also welcome improvements to the project documentation or to the existing
docs. Please file an [issue](https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/issues).
-->

<!--
<!--
## Policies

### Open Source Policy
Expand All @@ -103,13 +101,13 @@ questions, just [shoot us an email](mailto:[email protected]).

*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).
For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md).
-->

<!--
<!--
## Public domain

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.
-->
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.
-->
19 changes: 13 additions & 6 deletions tier1/hooks/post_gen_project.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
Loading