From 608f1cfbf909104ffa4f5199ca6d264eadebd7d9 Mon Sep 17 00:00:00 2001 From: Simon Baynes Date: Mon, 12 Feb 2024 18:29:11 +0000 Subject: [PATCH] Update contributing guidelines Closes #27 --- CONTRIBUTING.md | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9573943..5e243f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,31 @@ -##Contributing## -###Pull Requests### -After forking the repository please create a pull request before creating the fix. This way we can talk about how the fix will be implemeted. This will greatly increase your chance of your patch getting merged into the code base. \ No newline at end of file +# Contributing + +## Pull Requests + +After forking the repository please create a pull request before creating the fix. This way we can talk about how the +fix will be implemented. This will greatly increase your chance of your patch getting merged into the code base. + +## Commit Template + +Please run the following to make sure you commit messages conform to the project +standards. + +```bash +git config --local commit.template .gitmessage +``` + +## Markdown + +There are linting rules for the markdown documentation in this project. So +please adhere to them. This can be achieved by installing the node module +`markdownlint-cli`. + +```bash +npm install -g markdownlint-cli +``` + +Then to check your Markdown run. + +```bash +markdownlint . +``` \ No newline at end of file