News for hackers. Stuff that matters.
Re:Ask HN: What are the “best” codebases that you've encount... by dguo on Monday July 29, 2019 @03:06PM (#20558185)
Yep. For some of the larger projects that I've worked on, I've gotten into the habit of adding folder level READMEs. I don't know if anyone else has benefited from them, but I certainly have myself when I need to remind myself of some context or pitfalls.

Having a sensible folder structure and good folder names is nice, but taking a few minutes to write individual READMEs can make a repo even easier to understand.

There are no comments on this comment yet.