tldr-pages/tldr
1
1
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2024-12-27 02:43:04 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #381 from igorshubovych/remove-index-mention-from-contributing

Browse Source 
Remove index mention from Contributing.md guidelines
This commit is contained in:
Waldir Pimenta 2015-12-26 02:11:39 +00:00
commit 3d78b46ada
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -9,7 +9,7 @@ Contribution are most welcome! All `tldr` pages are stored in Markdown right her
## 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.
When setting up a brand new fork, run `make setup` to install the git pre-commit hook that will check errors in your changes with Markdown linter.
## Guidelines

4
Makefile
View File

@ -3,6 +3,10 @@ default: lint
all: setup index
index:
@echo "WARNING!"
@echo "Index rebuilding is deprecated."
@echo "You should not do it, unless you understand why you doing this."
@echo
@TLDRHOME=`pwd` ./scripts/build_index.rb
@echo "Index rebuilt."