npm / npm/documentation

[FEATURE] Make CONTRIBUTING.md files mention the RFC/RRFC process for new features?

Open
#249 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content
Dominant language
MDX
Stars
711
Forks
4.2k
Avg merge
4d 16h
Merged PRs (30d)
3

Description

What / Why

New feature requests get opened by new contributors in the issue trackers of npm/cli, etc and closed mentioning that the RRFC process should be used instead. The first place I found the RRFC process mentioned was in the reason for closing feature requests, not in README.md or CONTRIBUTING.md in https://github.com/npm/cli/blob/latest/CONTRIBUTING.md

When

  • n/a

Where

https://github.com/npm/cli/blob/latest/CONTRIBUTING.md
Various other repos in https://github.com/npm/

How

Current Behavior

No mention of RRFC process or what to do to request new features in README.md/CONTRIBUTING.md of npm/cli, and probably other repos.

(Some repos such as https://github.com/npm/npm-registry-fetch#contributing also have a 404 for their link to CONTRIBUTING.md "Contributors guide" https://github.com/npm/npm-registry-fetch/blob/main/CONTRIBUTING.md)

Expected Behavior

Add a section along the lines of:

New Features

New feature requests should be reported in the https://github.com/npm/rfcs/ repo instead of this repo. Please check if a similar feature request has been made already.

Who

  • n/a

References

  • n/a

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with npm/cli/CONTRIBUTING.md and compare the contributing guidance across the other npm repositories mentioned in the issue. Check the npm/rfcs repository for the current RRFC process and verify the npm-registry-fetch CONTRIBUTING.md link. Done means the relevant contributing documents explain where new feature requests belong and no longer point to missing contributor guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.