mirror of
https://github.com/tldr-pages/tldr.git
synced 2024-10-28 23:17:58 +01:00
CONTRIBUTING: add tip about pre-commit hook
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
This commit is contained in:
parent
4c0855c7e3
commit
1683b15205
1 changed files with 4 additions and 1 deletions
|
@ -148,7 +148,7 @@ Of course, this shouldn't sacrifice content clarity, such as when documenting to
|
|||
|
||||
### 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:
|
||||
|
||||
|
@ -164,6 +164,9 @@ tldr-lint <path/to/page.md>
|
|||
|
||||
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
|
||||
|
||||
The easiest way to submit a change is to edit the page directly on the GitHub interface.
|
||||
|
|
Loading…
Reference in a new issue