3 ms·
No naming scheme will be perfect. What you really need is a top–level document that describes what is inside each directory, and how they relate to each other.
by db48x 6y ago
No naming scheme will be perfect. What you really need is a top–level document that describes what is inside each directory, and how they relate to each other. In prose, with paragraphs, headings, links, and a table of contents. Use something like asciidoctor, markdown, or org-mode so that you have something that is readable in the terminal and can also be exported to HTML.
- bredren 6y agoThanks for this. Where do you generally see this document living? I mentioned in my reply to giorgioz, perhaps a readme on the root could offer this easy reference? I am curious if you have feedback on the other question I posed giorgioz around issue management on a monorepo.
- db48x 6y agoYea, right in the root directory. It doesn't necessarily have to be in the README, but the if it isn't then the README should mention it prominently.