Skip to content

Commit

Permalink
Merge pull request #81 from satwic007/sat/lint_tier_1_repo
Browse files Browse the repository at this point in the history
Tier1-4: Added Repolinter.json files
  • Loading branch information
natalialuzuriaga authored Apr 11, 2024
2 parents cbf892c + 14e93ff commit 3e58182
Show file tree
Hide file tree
Showing 5 changed files with 1,050 additions and 0 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
Loading

0 comments on commit 3e58182

Please sign in to comment.