From 4186ed1a52aaf3a0771efc7d69c44aaa69d8d640 Mon Sep 17 00:00:00 2001 From: Ruben Vereecken Date: Tue, 19 Jan 2016 14:28:43 +0100 Subject: [PATCH] Added contributing guidelines on tldr-lint --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 44091c136..910cfa0d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,6 +97,11 @@ Detailed explanation: 5. Run `make lint` to check that your page(s) are correct. Try to run the commands you are describing to ensure the syntax is correct. + You can use the formatting features of [tldr-lint](https://github.com/tldr-pages/tldr-lint) + (installed through `make setup` or alternatively `npm install tldr-lint`) + to automatically fix any mistakes you may have missed. + Try `tldr tldr-lint` for a quick how-to. + 6. Please use the following commit message format: `: type of change`.