Tier 0 Changes #272
Tier 0 Changes #272
Conversation
Signed-off-by: Sachin Panayil <[email protected]>
| @@ -1,145 +0,0 @@ | |||
| # {{ cookiecutter.project_name }} | |||
| {{ cookiecutter.project_description }} | |||
There was a problem hiding this comment.
I'm personally an advocate for keeping README.md since I think a project description is essential to have in a repository for context. Remy and I were exploring maybe generating a description using code.json. For example:
“REPONAME is a LANGUAGE project by CMS that PURPOSE by TEAM for REASON”
| @@ -1,115 +0,0 @@ | |||
| <!--- # NOTE: Modify sections marked with `TODO` --> | |||
|
|
|||
There was a problem hiding this comment.
Yes good to remove!
There was a problem hiding this comment.
Not approving as of now because I have to catch you up on all the changes we made to the maturity model framework. We'll discuss in our meeting soon.
Afterwards, could you handle making some README docs updates to the tier directories?
https://github.com/DSACMS/repo-scaffolder/blob/main/tier1/README.md
| @@ -0,0 +1,177 @@ | |||
| { | |||
| "extends": "https://raw.githubusercontent.com/DSACMS/repo-scaffolder/main/tier1/%7B%7Bcookiecutter.project_slug%7D%7D/repolinter.json", | |||
There was a problem hiding this comment.
Since Tier 0 is now considered the tier with our baseline repository requirements, I think it may be worth refactoring our repolinter.json files such that Tier 0 is the parent and Tier 1-4 extends from this
module-name: Tier 0 Changes
Problem
Tier 0 should be the baseline level for repositories that don't require any project owner input. Community files such as README should be removed
Solution
Removed the README and CONTRIBUTING and added CODEOWNERS and a supporting repolinter.json. The repolinter.json inherits from Tier 0 and just sets values to off only requiring the baseline stuff
Result
Tier 0 now only has baseline files included in it and a supporting repolinter.json that can be used via repolinter-actions
Some important notes regarding the summary line:
Test Plan
Tested locally with
repolinter lint .