3 ms·
It's a coincidence I just looked at that Q&A a couple nights ago. I had never heard of the "HACKING" file before but I like it. Is there a list somewhere of com
by cpburns2009 3y ago
It's a coincidence I just looked at that Q&A a couple nights ago. I had never heard of the "HACKING" file before but I like it. Is there a list somewhere of commonly used README-esque files used in open source projects?
- mikepurvis 3y agoI dunno about a list, but contributing, code-of-conduct, and license are all pretty common.
- hollerith 3y agoINSTALL and LICENSE are the important ones. Maybe also BUGS (i.e., how to report bugs) and CONTRIBUTORS.
- kps 3y agoAnd NEWS or CHANGES or similar.
- k4rli 3y agoAlways lovely to see a CHANGELOG.md
- eddd-ddde 3y agoEven more lovely to see a ARCHITECTURE.md
- eternityforest 3y agoI think install instructions belong in README. It's always nice to see "pip install foo" in a readme letting me know it's properly packaged and not something I'll have to compile myself or something just to try it.
- unwind 3y agoIn the linked answer? It had most of GNU's coding standard quoted.
- cpburns2009 3y agoThe GNU coding standards only lists three: README, INSTALL, and COPYING.
- paulddraper 3y agoCONTRIBUTING
- eternityforest 3y agoI used to have HACKING but now I try to go for extremely obvious code with nothing people aren't already familiar with, plus GitHub Wiki. Next step is cleaning stuff up in a way that would make automatic documentation generation useful.