Skip to content

Commit

Permalink
fix maturity model merge conflict
Browse files Browse the repository at this point in the history
Signed-off-by: Natalia Luzuriaga <[email protected]>
  • Loading branch information
natalialuzuriaga committed Apr 11, 2024
2 parents e3f564d + 3e58182 commit 7f0a61e
Show file tree
Hide file tree
Showing 22 changed files with 1,126 additions and 57 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Templates and commandline tools for creating repositories for US Federal open so
- python
- github cli
- cookiecutter
- [repolinter](https://github.com/todogroup/repolinter)

## Need help picking a tier?
If you do not know what tier your project is, the cookiecutter will walk you through questions to figure out what tier you need. Run:
Expand Down Expand Up @@ -37,6 +38,17 @@ be filled in by the answers to `cookiecutter.json`. For example, `{{ cookiecutt
this question - `"project_name": "My Project",`. See the [cookiecutter docs](https://cookiecutter.readthedocs.io/en/stable/)
for more information.

## Repolinter
Tiers of level 1 thru 4 have repolinter.json file in their projects. Tier1 has detailed configuration of all the rules. All the other tiers extends their previuos tiers and has only the `rule` and the `level` configuration.

Sample commands to run with the given repolinter.json path:

```
repolinter lint .
repolinter lint tier4/\{\{cookiecutter.project_slug\}\}
```

## Maturity Models
See our Maturity Model Tiers Document for reference: https://github.com/DSACMS/repo-scaffolder/blob/main/maturity-model-tiers.pdf

Expand Down
6 changes: 3 additions & 3 deletions tier0/{{cookiecutter.project_slug}}/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
2. Check out the `main` branch
3. Create a feature branch
4. Write code and tests for your change
5. From your branch, make a pull request against `cmsgov/cmsgov-example-repo/main`
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
7. Wait for your change to be pulled into `cmsgov/cmsgov-example-repo/main`
7. Wait for your change to be pulled into `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
8. Delete your feature branch
-->

Expand Down Expand Up @@ -87,7 +87,7 @@ TODO: Example Issue Guides
TODO: Documentation Example
We also welcome improvements to the project documentation or to the existing
docs. Please file an [issue](https://github.com/cmsgov/cmsgov-example-repo/issues).
docs. Please file an [issue](https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/issues).
-->

<!--
Expand Down
6 changes: 4 additions & 2 deletions tier0/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# {{ cookiecutter.project_name }}

{{ cookiecutter.project_description }}

## About the Project
Expand Down Expand Up @@ -74,6 +73,9 @@ TODO: Using the "tree -d" command can be a helpful way to generate this informat

<!--
## Coding Style and Linters
TODO - Add the repo's linting and code style guidelines
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.
-->

Expand All @@ -96,7 +98,7 @@ Pull-requests are merged to `main` and the changes are immediately deployed to t

<!--
## Community
The **{project name}** 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.
The {{ cookiecutter.project_name }} 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.
We 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.
Expand Down
6 changes: 3 additions & 3 deletions tier1/{{cookiecutter.project_slug}}/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
2. Check out the `main` branch
3. Create a feature branch
4. Write code and tests for your change
5. From your branch, make a pull request against `cmsgov/cmsgov-example-repo/main`
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
7. Wait for your change to be pulled into `cmsgov/cmsgov-example-repo/main`
7. Wait for your change to be pulled into `{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/main`
8. Delete your feature branch
-->

Expand Down Expand Up @@ -89,7 +89,7 @@ When creating an issue please try to adhere to the following format:
TODO: Documentation Example
We also welcome improvements to the project documentation or to the existing
docs. Please file an [issue](https://github.com/cmsgov/cmsgov-example-repo/issues).
docs. Please file an [issue](https://github.com/{{ cookiecutter.project_org }}/{{ cookiecutter.project_repo_name }}/issues).
-->

## Policies
Expand Down
9 changes: 6 additions & 3 deletions tier1/{{cookiecutter.project_slug}}/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## **{Project Name}**
**{project description}**
# {{ cookiecutter.project_name }}
{{ cookiecutter.project_description }}

## About the Project
**{project statement}**
Expand Down Expand Up @@ -50,6 +50,9 @@ This project is monorepo with several apps. Please see the [api](./api/README.md

<!--
## Coding Style and Linters
TODO - Add the repo's linting and code style guidelines
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.
-->

Expand Down Expand Up @@ -82,7 +85,7 @@ The contents of this repository are managed by **{responsible organization(s)}**

<!--
## Community
The **{project name}** 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.
The {{ cookiecutter.project_name }} 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.
We 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.
Expand Down
Loading

0 comments on commit 7f0a61e

Please sign in to comment.