Skip to content
This repository has been archived by the owner on Sep 10, 2022. It is now read-only.

Add comments clarifying what files do #57

Open
owencm opened this issue Dec 4, 2015 · 2 comments
Open

Add comments clarifying what files do #57

owencm opened this issue Dec 4, 2015 · 2 comments

Comments

@owencm
Copy link

owencm commented Dec 4, 2015

There is a lot of stuff going on in this repo. I think it would be really helpful to have at least a few sentences at the start of files such as Dockerfile, app.yaml and gulpfile.js (and probably many other files) to clarify what they do.

I think that would really help people trying to orient their way around this and work out what to modify / rip out for their own variation.

@addyosmani
Copy link
Contributor

Agree completely. I think an appendix walking through the responsibilities of our different files (or comments in files) would be valuable.

@addyosmani
Copy link
Contributor

Would there be value in us having an appendix.md file that walks through what each directory / roughly what the important files in the repo correspond to? (cc @gauntface for his thoughts too)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants