Skip to content

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

@bnb

Description

@bnb

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 😄

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to the documentations.metaIssues and PRs related to the general management of the project.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions