MLH-Fellowship / 0.2.1-readme-dirs

A web application that generates helpful project structures for public GitHub repositories
https://project-structure-readme.netlify.app/
MIT License
1 stars 1 forks source link

Include comments for common dirs in "tree printout" generation algorithm #14

Closed nchaloult closed 4 years ago

nchaloult commented 4 years ago

When we're generating the "tree printout" for a public GitHub repo, if we recognize any common folders, we should include little comments next to those folders in the printout.

For instance, if we find a folder called src/ at the root directory of the repo, then that folder should have a comment next to it like this:

📂 public
📂 src # Source files
├── 📂 Components
...

This issue involves implementing this functionality, as well as deciding what common folders we will look for and what comments we should put next to them in the generated printout.