Skip to content

Commit

Permalink
chore(contributing.md): add conventional commit info (npm#5169)
Browse files Browse the repository at this point in the history
Update info on coverage too, it's auto-enforce now no separate command
needed.
  • Loading branch information
wraithgar authored Jul 20, 2022
1 parent bf3b26c commit 68ade72
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 68ade72

Please sign in to comment.