diff options
| author | Gar <gar+gh@danger.computer> | 2022-07-20 21:38:59 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-20 21:38:59 +0300 |
| commit | 68ade72624e279c485b8c008667fa09ee477c516 (patch) | |
| tree | ac7b6489bebed72dc2e1d56c32078950bb02553b /CONTRIBUTING.md | |
| parent | bf3b26cc8389164d3ad05353ac76ad94666f3ed3 (diff) | |
chore(contributing.md): add conventional commit info (#5169)
Update info on coverage too, it's auto-enforce now no separate command
needed.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b32e47ce2..e12e30021 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,15 +35,18 @@ $ node . run test **5. Open a [Pull Request](https://github.com/npm/cli/pulls) for your work & become the newest contributor to `npm`! 🎉** -## Test Coverage +## Pull Request Conventions -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. +We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). When opening a pull request, please be sure that either the pull request title, or each commit in the pull request, has one of the following prefixes: -**You can find out what the current test coverage percentage is by running...** + - `feat`: For when introducing a new feature. The result will be a new semver minor version of the package when it is next published. + - `fix`: For bug fixes. The result will be a new semver patch version of the package when it is next published. + - `docs`: For documentation updates. The result will be a new semver patch version of the package when it is next published. + - `chore`: For changes that do not affect the published module. Often these are changes to tests. The result will be *no* change to the version of the package when it is next published (as the commit does not affect the published version). -```bash -$ node . run check-coverage -``` +## Test 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. Tap also reports on code coverage and it will fail if that drops below 100%. ## Performance & Benchmarks |