From bc7a9187ef5fba2c456849f10bfbbe87e0b34820 Mon Sep 17 00:00:00 2001
From: Maksym Vlasov <MaxymVlasov@users.noreply.github.com>
Date: Mon, 10 Jun 2024 21:09:56 +0300
Subject: [PATCH] docs: Describe which tools should be installed to avoid
 common errors (#678)

---
 .github/CONTRIBUTING.md | 10 ++++++++++
 .vscode/extensions.json | 26 ++++++++++++++++++++++++++
 .vscode/settings.json   | 10 ++++++++++
 3 files changed, 46 insertions(+)
 create mode 100644 .vscode/extensions.json
 create mode 100644 .vscode/settings.json

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 1d1568e51..8066f6f30 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -12,6 +12,7 @@ Enjoy the clean, valid, and documented code!
   * [Run via Docker](#run-via-docker)
   * [Check results](#check-results)
   * [Cleanup](#cleanup)
+* [Required tools and plugins to simplify review process](#required-tools-and-plugins-to-simplify-review-process)
 * [Add new hook](#add-new-hook)
   * [Before write code](#before-write-code)
   * [Prepare basic documentation](#prepare-basic-documentation)
@@ -98,6 +99,13 @@ Results will be located at `./test/results` dir.
 sudo rm -rf tests/results
 ```
 
+## Required tools and plugins to simplify review process
+
+1. [editorconfig.org](https://editorconfig.org/) (preinstalled in some IDE)
+2. [pre-commit](https://pre-commit.com/#install)
+3. (Optional) If you use VS Code - feel free to install all recommended extensions
+
+
 ## Add new hook
 
 You can use [this PR](https://github.com/antonbabenko/pre-commit-terraform/pull/252) as an example.
@@ -106,6 +114,8 @@ You can use [this PR](https://github.com/antonbabenko/pre-commit-terraform/pull/
 
 1. Try to figure out future hook usage.
 2. Confirm the concept with [Anton Babenko](https://github.com/antonbabenko).
+3. Install [required tools and plugins](#required-tools-and-plugins-to-simplify-review-process)
+
 
 ### Prepare basic documentation
 
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
new file mode 100644
index 000000000..25c4c5f1f
--- /dev/null
+++ b/.vscode/extensions.json
@@ -0,0 +1,26 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+    // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+    // List of extensions which should be recommended for users of this workspace.
+    "recommendations": [
+      // Global
+      "aaron-bond.better-comments",
+      "gruntfuggly.todo-tree",
+      "shardulm94.trailing-spaces",
+      "glenbuktenica.unicode-substitutions",
+      "editorconfig.editorconfig",
+
+      // Grammar
+      "streetsidesoftware.code-spell-checker",
+      "znck.grammarly",
+
+      // Documentation
+      "bierner.markdown-preview-github-styles",
+      "yzhang.markdown-all-in-one",
+      "DavidAnson.vscode-markdownlint",
+
+    ],
+    // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+    "unwantedRecommendations": []
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
new file mode 100644
index 000000000..c1dc51901
--- /dev/null
+++ b/.vscode/settings.json
@@ -0,0 +1,10 @@
+{
+  "editor.guides.bracketPairs": "active",
+  "markdown.extension.toc.unorderedList.marker": "*",
+  "markdown.extension.toc.levels": "2..6",
+  "cSpell.language": "en",
+  "markdownlint.config": {
+    "code-block-style": false
+  },
+  "markdown.validate.enabled": true,
+}