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

docs(contributing): added instructions on how to run gitbook locally

Browse Source
This commit is contained in:
Emmanuel Sciara 2019-07-31 01:34:51 +02:00 committed by Gregor Martynus
parent 813e5f65ed
commit a3da21a544
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@ -9,6 +9,7 @@ As a contributor, here are the guidelines we would like you to follow:
- [Submitting a Pull Request](#submitting-a-pull-request)
- [Coding rules](#coding-rules)
- [Working with the code](#working-with-the-code)
- [Working with the doc](#working-with-the-doc)
We also recommend that you read [How to Contribute to Open Source](https://opensource.guide/how-to-contribute).
@ -249,3 +250,10 @@ $ npm run test
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.
## Working with the doc
Working with the doc is like [working with the code](#working-with-the-code), with the difference that you might find useful to see your changes locally before submitting.
You can do that by following the instructions on [how to use gitbook locally](https://til.secretgeek.net/gitbook/use_gitbook_locally.html).