DawnMagnet/tldr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added contributing guidelines on tldr-lint

Browse Source
This commit is contained in:
Ruben Vereecken
2016-01-19 14:28:43 +01:00
parent 5782425234
commit 4186ed1a52
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@@ -97,6 +97,11 @@ Detailed explanation:
5. Run `make lint` to check that your page(s) are correct. Try to run the commands you are describing to ensure the syntax is correct. 5. Run `make lint` to check that your page(s) are correct. Try to run the commands you are describing to ensure the syntax is correct.
You can use the formatting features of [tldr-lint](https://github.com/tldr-pages/tldr-lint)
(installed through `make setup` or alternatively `npm install tldr-lint`)
to automatically fix any mistakes you may have missed.
Try `tldr tldr-lint` for a quick how-to.
6. Please use the following commit message format: 6. Please use the following commit message format:
`<command>: type of change`. `<command>: type of change`.