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

CONTRIBUTING: add tip about pre-commit hook 

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
pull/23/head
K.B.Dharun Krishna 2023-12-06 09:28:54 +05:30 committed by Starbeamrainbowlabs
parent 4c0855c7e3
commit 1683b15205
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -148,7 +148,7 @@ Of course, this shouldn't sacrifice content clarity, such as when documenting to
### Testing pages locally ### Testing pages locally
Once you have written a `tldr` page, you can test it's syntax locally using [`tldr-lint`](https://github.com/tldr-pages/tldr-lint). Once you have written a `tldr` page, you can test its syntax locally using [`tldr-lint`](https://github.com/tldr-pages/tldr-lint).
The latest version of [NodeJS](https://nodejs.org) is required to install `tldr-lint` with the following command: The latest version of [NodeJS](https://nodejs.org) is required to install `tldr-lint` with the following command:
@ -164,6 +164,9 @@ tldr-lint <path/to/page.md>
Now, you are ready to submit a pull request! Now, you are ready to submit a pull request!
> [!TIP]
> Additionally, inside the `tldr` directory you can install the dependencies using `npm install` command and now when you commit your changes, the tests will run automatically via the pre-commit hook.
### Submitting changes ### Submitting changes
The easiest way to submit a change is to edit the page directly on the GitHub interface. The easiest way to submit a change is to edit the page directly on the GitHub interface.