mirror of
https://github.com/tldr-pages/tldr.git
synced 2024-08-16 23:40:43 +03:00
Update CONTRIBUTING.md
Explained the use of the Makefile to setup the git pre-commit hook that rebuilds the index.
This commit is contained in:
parent
2d38990e82
commit
1e157d94ed
@ -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.*
|
||||
|
||||
## 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
|
||||
|
||||
Note that `tldr` is focussed on concrete examples.
|
||||
|
Loading…
Reference in New Issue
Block a user