📝 New rule - Do you use README templates? #9765
Conversation
Calinator444
changed the title
github-actions
bot
added
Age: 🥚 - New
Hey @Calinator444 O fixed the Markdown for bad and good examples
There was a problem hiding this comment.
Hey @Calinator444
- Please add this new rule to a category, so it's not orphaned
- Also add to related (back and forth): https://www.ssw.com.au/rules/awesome-readme/
github-actions
bot
added
Age: 🐤 - Mature
|
Howzit @Calinator444, This PR has been here a while. Did you know you should avoid merge debt?
Thanks! |
…lates/rule' of https://github.com/Calinator444/SSW.Rules.Content into cms/Calinator444/SSW.Rules.Content/rule/use-readme-templates/rule
✅ Done - I added related links back and forth between this rule and the awesome readmes rule |
|
Hey @Calinator444
|
rules/use-readme-templates/rule.md
Outdated
| ### Gold standard READMEs | ||
|
|
||
| Gold standard READMEs are primarily for public facing projects. They should primarily focus on getting the audience invested and excited to see the project succeed. This fosters a healthy community that will band together to see the project succeed | ||
|
|
||
| Social media links, exciting graphics and entertaining explanation videos are of paramount importance so that the community remains invested and has a sense of ownership for the project. | ||
|
|
||
|  | ||
|
|
||
| ### Silver standard READMEs | ||
|
|
||
| The silver README standard prioritizes a smooth developer experience as well as making the project handover easier. Note how the social media links have been removed and instructions for setting up the project have been brought to the forefront at the top of the README. The instructions for contributing are also much more detailed. | ||
|
|
||
|  | ||
|
|
||
| ### Bronze READMEs | ||
|
|
||
| The bronze README standard is designed for projects where scalability is a low priority, and the scope of the project is limited. The README template should only be used to expedite making the repository public, or accessible to any contributing team members. In this case approaches to make the project more marketable take a back seat in favor of making the README quick and easy to digest. | ||
|
|
||
|  |
There was a problem hiding this comment.
The differences between bronze, silver, and gold seem arbitrary. I believe that if I was starting a project, I wouldn't want to look at 3 different templates but instead pick up one and leave out the bits that I didn't need.
I'd recommend implementing 1 template (so people always try to go for gold)
Also, there's no link to a template, so I can't copy anything - recommend having a link to a file on GitHub so people can copy/paste it
There was a problem hiding this comment.
I partially agree with @wicksipedia
It would be great to have a template to copy/follow.
However I am OK with the different ways of doing it - from my understanding depending on the scalability of the project.
Maybe change from
GOLD
SILVER
BRONZE
to
PUBLIC
INTERNAL
PERSONAL
PS. I'm not strong about this, so happy to go with what is decided between devs ;)
There was a problem hiding this comment.
I wouldn't want to look at 3 different templates but instead pick up one and leave out the bits that I didn't need.
100%. Just have the headings/sections that would constitute an "ideal" readme and let people strip out superfluous sections
✏️ It was originally an email from Seth but I lost it - It did say to seek approval from Matt before publishing this rule
✏️I added a new rule about using README templates with examples of a gold, bronze and silver standard readme
✏️N/A - but I had the content checked by Tiago