Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDarcy Clarke <darcy@darcyclarke.me>2021-09-08 19:08:03 +0300
committerGar <gar+gh@danger.computer>2021-09-08 19:57:34 +0300
commit64f7d1a55db99b1aaf8fb59557b3dedcdcd954a0 (patch)
treea290e2ab8f78954040dbbface1a66fcda45e746e /CONTRIBUTING.md
parentd6c651c050634a89f25846340a440dfb49755f82 (diff)
docs(contributing): add note on changes to tooling
PR-URL: https://github.com/npm/cli/pull/3727 Credit: @darcyclarke Close: #3727 Reviewed-by: @wraithgar
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ec1c51386..5ee9b4560 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,6 +4,10 @@
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).
+## Reporting Bugs
+
+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.
+
## Development
**1. Clone this repository...**
@@ -33,7 +37,7 @@ $ npm run test
## 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.
+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.
**You can find out what the current test coverage percentage is by running...**
@@ -51,10 +55,12 @@ We've set up an automated [benchmark](https://github.com/npm/benchmarks) integra
You can learn more about this tool, including how to run & configure it manually, [here](https://github.com/npm/benchmarks)
-## Dependency Updates
+## What _not_ to contribute?
+
+### Dependencies
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.
-## Reporting Bugs
+### Tools/Automation
-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.
+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.)