From 1683b15205818562438910fdaef3ac89fad349d9 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Wed, 6 Dec 2023 09:28:54 +0530 Subject: [PATCH] CONTRIBUTING: add tip about pre-commit hook Signed-off-by: K.B.Dharun Krishna --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 856a597521..c4f16a26e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 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.