ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md 

Explained the use of the Makefile to setup the git pre-commit hook that rebuilds the index.
waldyrious/alt-syntax
Ruben Vereecken 2015-04-12 21:54:27 +02:00
parent 2d38990e82
commit 1e157d94ed
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -7,6 +7,10 @@ Contribution are most welcome! All `tldr` pages are stored in Markdown right her
*Note: when submitting a new command, don't forget to check if there's already a pull request in progress.* *Note: when submitting a new command, don't forget to check if there's already a pull request in progress.*
## Setup
When setting up a brand new fork, run `make setup` to install the git pre-commit hook that will rebuild the index every time you commit your changes. You can also rebuild it manually by running `make index`. The script requires Ruby to run. Make sure you have the index in place as we will need it as part of your commit in order to pull in your changes.
## Guidelines ## Guidelines
Note that `tldr` is focussed on concrete examples. Note that `tldr` is focussed on concrete examples.