-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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
Comments
README.md is already very lengthy -- maybe put the information somewhere under https://github.com/nodejs/node/blob/master/CONTRIBUTING.md? |
|
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). |
Could be a text file (for example, |
+1 I'm experimenting with a commitizen plug-in and that would be useful |
Related issue: #24117 |
Subsystems are listed (using some shorthand, but that can be changed) in |
@bnb ... should this remain open? I know it hasn't been resolved. |
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. |
Fixed in #35718 |
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 😄
The text was updated successfully, but these errors were encountered: