-
-
Notifications
You must be signed in to change notification settings - Fork 33.5k
Description
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 😄