Skip to content

Commit

Permalink
docs: Describe which tools should be installed to avoid common errors (
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxymVlasov authored Jun 10, 2024
1 parent a4ad28b commit bc7a918
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand All @@ -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

Expand Down
26 changes: 26 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -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": []
}
10 changes: 10 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -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,
}

0 comments on commit bc7a918

Please sign in to comment.