Readme files for public libraries/apps have a format, roughly GNU Gnits & what...
Readme files for public libraries/apps have a format, roughly GNU Gnits & what evolved. So Title/Desc/Installing/Usage/Other Stuff/Maybe Credits/Changes/Links to more docs
I keep trying to use this format at work & it it doesn't work. Closed source readme should be the contributing.md file.
Self-replies
Challenges I've had with contributing.md files
- They change fast, about every year 80% of it is out of date.
- Developers & tech leads are opinionated and want n different ways to do everything
- If you have a poly/mono repo you got n overlapping, similar contributing.md files
- They get out of sync with artifacts like the build script
- the line between "let me teach you the basics" and "I can assume you know the basic" is fuzzy