diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d62bcc2..98eb4f03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -247,6 +247,8 @@ $ npm install ### Lint +[//]: # "TODO: rework these docs" + All the [semantic-release](https://github.com/semantic-release) repositories use [XO](https://github.com/sindresorhus/xo) for linting and [Prettier](https://prettier.io) for formatting. Prettier formatting will be automatically verified and fixed by XO. @@ -259,6 +261,8 @@ Before pushing your code changes make sure there are no linting errors with `npm ### Tests +[//]: # "TODO: rework these docs too" + Running the integration test requires you to install [Docker](https://docs.docker.com/engine/installation) on your machine. All the [semantic-release](https://github.com/semantic-release) repositories use [AVA](https://github.com/avajs/ava) for writing and running tests. @@ -277,6 +281,8 @@ $ npm run test ### Commits +[//]: # "TODO: these docs are already out of date. i'd value cleaning up the commitizen support, but w/o a special script" + All the [semantic-release](https://github.com/semantic-release) repositories use [Commitizen](https://github.com/commitizen/cz-cli) to help you create [valid commit messages](#commit-message-guidelines). After staging your changes with `git add`, run `npm run cm` to start the interactive commit message CLI.