npm / npm/rfcs

[RRFC] npm changes command

Open
#145 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
777
Forks
267
PR merge metrics
No merged PRs in 30d

Description

Motivation ("The Why")

This idea is derived from npm diff RFC in PR #144

I think many authors would appreciate an idea of what changes could affect the consumer, which would typically come from CHANGELOG.md.

I think this idea could be an interesting complement to PR #144.

Example

Contrived, not properly colorized:

% npm changes create-react-native-module 0.20.0..1.0.0

* bump minimum react-native version to 1.0.0
* drop support for Node.js pre-14
How
Current Behaviour

Consumer would check CHANGELOG.md on GitHub or wherever else.

Desired Behaviour

see contrived example above

References
  • PR #144 - add npm diff

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 by reading the linked npm diff RFC in PR #144 and the proposal's motivation and example. Define the behavior for an npm changes command that summarizes consumer-facing changes between two versions, using CHANGELOG.md as the described source. Done means the command's scope and output are agreed for the RFC.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.