Skip to content

Commit 64f7d1a

Browse files
darcyclarkewraithgar
authored andcommitted
docs(contributing): add note on changes to tooling
PR-URL: #3727 Credit: @darcyclarke Close: #3727 Reviewed-by: @wraithgar
1 parent d6c651c commit 64f7d1a

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
All interactions in the **npm** organization on GitHub are considered to be covered by our standard [Code of Conduct](https://docs.npmjs.com/policies/conduct).
66

7+
## Reporting Bugs
8+
9+
When submitting a new bug report, please first [search](https://github.com/npm/cli/issues) for an existing or similar report & then use one of our existing [issue templates](https://github.com/npm/cli/issues/new/choose) 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.
10+
711
## Development
812

913
**1. Clone this repository...**
@@ -33,7 +37,7 @@ $ npm run test
3337

3438
## Test Coverage
3539

36-
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.
40+
We use [`tap`](https://node-tap.org/) for testing & 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.
3741

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

@@ -51,10 +55,12 @@ We've set up an automated [benchmark](https://github.com/npm/benchmarks) integra
5155

5256
You can learn more about this tool, including how to run & configure it manually, [here](https://github.com/npm/benchmarks)
5357

54-
## Dependency Updates
58+
## What _not_ to contribute?
59+
60+
### Dependencies
5561

5662
It should be noted that our team does not accept third-party dependency updates/PRs. We have a [release process](https://github.com/npm/cli/wiki/Release-Process) that includes checks to ensure dependencies are staying up-to-date & will ship security patches for CVEs as they occur. If you submit a PR trying to update our dependencies we will close it with or without a reference to these contribution guidelines.
5763

58-
## Reporting Bugs
64+
### Tools/Automation
5965

60-
When submitting a new bug report, please first [search](https://github.com/npm/cli/issues) for an existing or similar report & then use one of our existing [issue templates](https://github.com/npm/cli/issues/new/choose) 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.
66+
Our core team is responsible for the maintaince of the tooling/automation in this project & we ask collaborators to kindle not make changes to these when contributing (ex. `.github/*`, `.eslintrc.json`, `.licensee.json` etc.)

0 commit comments

Comments
 (0)