Contributing

Code of Conduct

All interactions in thenpm organization on GitHub are considered to be covered by our standardCode of Conduct.

Development

1. Clone this repository...

$ git clone git@github.com:npm/cli.git

2. Navigate into project & install development-specific dependencies...

$cd ./npm&& npm install

3. Write some code &/or add some tests...

...

4. Run tests & ensure they pass...

$ npm run test

5. Open aPull Request for your work & become the newest contributor tonpm!🎉

Test Coverage

We expect that every new feature or bug fix comes with corresponding tests that validate the solutions. We strive to have as close to, if not exactly, 100% code coverage.

You can find out what the current test coverage percentage is by running...

$ npm run test-coverage

Performance & Benchmarks

We've set up an automatedbenchmark integration that will run against all Pull Requests; Posting back a comment with the results of the run.

Example:

You can learn more about this tool, including how to run & configure it manually,here

Reporting Bugs

When submitting a new bug report, please firstsearch for an existing or similar report & then use one of our existingissue templates if you believe you've come across a unique problem. Duplicate issues, or issues that don't use one of our templates may get closed without a response.