Skip to content
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

Include list of all subsystems/topics in README.md #23749

Closed
bnb opened this issue Oct 19, 2018 · 10 comments
Closed

Include list of all subsystems/topics in README.md #23749

bnb opened this issue Oct 19, 2018 · 10 comments
Labels
doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project.

Comments

@bnb
Copy link
Contributor

bnb commented Oct 19, 2018

Is your feature request related to a problem? Please describe.
Approaching Node.js as a first time contributor or someone trying to understand the project's processes.

Describe the solution you'd like
List out and define all subsystems/topics in the README.md file. Examples of what I'm referring to: deps, doc, test, meta, build, util. These are terms we use heavily in PRs but don't actually say what they are nor is there really any indication that they have meaning outside of their usage.

Describe alternatives you've considered
Listing in a different file or location and linking is not as useful, since it will not be nearly as discoverable. Not sure there are additional alternatives. Maybe a probot app that automagically comments on any issue that has a subsystem/topic attached with the definition? A PR to add those definitions to the README.md seems like a significantly lower barrier 😄

@richardlau
Copy link
Member

README.md is already very lengthy -- maybe put the information somewhere under https://github.com/nodejs/node/blob/master/CONTRIBUTING.md?

@Trott
Copy link
Member

Trott commented Oct 19, 2018

core-validate-commit maintains a list of valid subsystems. It would be nice if there was a way to not have to keep this proposed list and that list in synch--if they could both get the list from the same place, or if the list proposed here could be in a format consumable by core-validate-commit.

@Trott
Copy link
Member

Trott commented Oct 19, 2018

FWIW, our Travis runs currently flag any PRs where the first commit does not contain a valid subsystem in the title line of the commit message. This is a recent addition (and one that has caused some problems and needed some tweaking, but I'm cautiously optimistic that we have something reasonably useful now).

@mmarchini
Copy link
Contributor

or if the list proposed here could be in a format consumable by core-validate-commit.

Could be a text file (for example, .subsystems) with one subsystem per line, and then we could reference this file in https://github.com/nodejs/node/blob/master/CONTRIBUTING.md.

@targos
Copy link
Member

targos commented Oct 19, 2018

+1 I'm experimenting with a commitizen plug-in and that would be useful

@Fishrock123 Fishrock123 added doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. labels Oct 20, 2018
@Trott
Copy link
Member

Trott commented Nov 6, 2018

Related issue: #24117

@Trott
Copy link
Member

Trott commented Nov 24, 2018

Subsystems are listed (using some shorthand, but that can be changed) in onboarding-extras.md and I would love to see them pulled out of there and put into CONTRIBUTING.md.

@jasnell
Copy link
Member

jasnell commented Jun 26, 2020

@bnb ... should this remain open? I know it hasn't been resolved.

@bnb
Copy link
Contributor Author

bnb commented Jun 26, 2020

It would be nice and I’d be happy to PR but if it’s not going to happen feel free to close! Totally understand if not, though.

@PoojaDurgad
Copy link
Contributor

Fixed in #35718

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

No branches or pull requests

8 participants