search

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

Add descriptive comments to common directories in projects #15

Closed nchaloult closed 4 years ago

nchaloult commented 4 years ago

Closes #14

This PR proposes to introduce new functionality during the "tree printout" generation process: if we recognize a common type of directory, then we add a helpful comment or description next to that folder's name.

See constants.ts file to see all of the common directory types that I thought of supporting. If I've missed a common directory that we could support, please write a new key-value pair on the commonDirComments object in constants.ts and add a new commit onto this branch!

nchaloult commented 4 years ago

That's a good idea! Do you want to add support for those folders and toss a commit on this branch before we merge it into master?

ralph-dev commented 4 years ago

@nchaloult I'll just add an issue for it so there is a lot of directories we can add them all at once! This is good to merge!