simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(contributing): captured notes to update the contributing guide based on conversation result

Browse Source
This commit is contained in:
Matt Travi 2023-09-17 09:48:34 -05:00
parent 65aea33182
commit aaed2f4a6f
No known key found for this signature in database
GPG Key ID: 8C173646C24FED70
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -247,6 +247,8 @@ $ npm install
### Lint ### 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. 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. 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 ### Tests
[//]: # "TODO: rework these docs too"
Running the integration test requires you to install [Docker](https://docs.docker.com/engine/installation) on your machine. 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. 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 ### 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). 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. After staging your changes with `git add`, run `npm run cm` to start the interactive commit message CLI.