-
Notifications
You must be signed in to change notification settings - Fork 165
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Disambiguate technology stack
and dependencies
sections
#11
Comments
👍 |
👍 Bump. To me, having both sections seems a bit too fiddly. Or, reading the description of "tech stack" in the template, I get a totally different understanding than what I assumed from just the heading of "tech stack".
This feels more like something that should be part of the general intro/description of the project. The phrase "tech stack", on the other hand, says to me nearly the exact same thing as "dependencies". |
👍 I don't find "tech stack" particularly useful. If I'm browsing a project and reading its README, "Tech Stack" seems like the sort of section I would gloss over to get to the dependencies. When encountering a new project on Github my personal thoughts are usually something along the lines of:
That's why Dependencies, Installation, Examples, and some basic documentation or links to documentation are important, I think. |
A realization I just had in the thread that precipitated this thread was: dependencies/tech stack for simply USING/running the software are different from the requirements/typical path for CONTRIBUTING to the software. This was the subconscious issue underlying my after-the-fact objection to mentioning OS X and Homebrew in the "tech stack" section of the cfgov-refresh README. |
pr's are welcome |
The Technology Stack and Dependencies sections overlap each other and it's not clear what should be included in one versus the other. Are there examples in the existing code base?
It seems helpful to have the dependencies section list the software that is then installed in Installation section that immediate follows it.
The text was updated successfully, but these errors were encountered: