-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: refactor contributing guide - linter requirements (#1412)
Signed-off-by: Yash Pimple <97302447+YashPimple@users.noreply.github.com> Signed-off-by: Yash Pimple <yashpimple22@gmail.com> Signed-off-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com> Co-authored-by: Meg McRoberts <DreidelLhasa@yahoo.com> Co-authored-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
- Loading branch information
3 people
committed
Jun 12, 2023
1 parent
a7f54ad
commit 2ccdec7
Showing
2 changed files
with
105 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
101 changes: 101 additions & 0 deletions
101
docs/content/en/contribute/docs/linter-requirements/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| --- | ||
| title: Linter Requirements | ||
| description: To maintain optimal code quality, this project employs linters which require a specific IDE configuration for effective utilization. | ||
| weight: 400 | ||
| --- | ||
|
|
||
| ## Linter Requirements | ||
|
|
||
| This project uses a set of linters to ensure good code quality. | ||
| In order to make proper use of those linters inside an IDE, | ||
| the following configuration is required. | ||
|
|
||
| ### Golangci-lint | ||
|
|
||
| Further information can also be found in | ||
| the [`golangci-lint` documentation](https://golangci-lint.run/usage/integrations/). | ||
|
|
||
| #### Visual Studio Code | ||
|
|
||
| In Visual Studio Code the | ||
| [Golang](https://marketplace.visualstudio.com/items?itemName=aldijav.golangwithdidi) | ||
| extension is required. | ||
|
|
||
| Adding the following lines to the `Golang` extension | ||
| configuration file enables all linters used in this project. | ||
|
|
||
| ```json | ||
| "go.lintTool": { | ||
| "type": "string", | ||
| "default": "golangci-lint", | ||
| "description": "GolangGCI Linter", | ||
| "scope": "resource", | ||
| "enum": [ | ||
| "golangci-lint", | ||
| ] | ||
| }, | ||
| "go.lintFlags": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "default": ["--fast", "--fix"], | ||
| "description": "Flags to pass to GCI Linter", | ||
| "scope": "resource" | ||
| }, | ||
| ``` | ||
|
|
||
| #### GoLand / IntelliJ requirements | ||
|
|
||
| * Install either the **GoLand** or **IntelliJ** Integrated Development Environment | ||
| (IDE) for the Go programming language, plus the [Go Linter](https://plugins.jetbrains.com/plugin/12496-go-linter) plugin. | ||
|
|
||
| * The plugin can be installed via `Settings` >> `Plugins` >> `Marketplace`, | ||
| search for `Go Linter` and install it. | ||
| Once installed, make sure that the plugin is using the `.golangci.yml` | ||
| file from the root directory. | ||
|
|
||
| * The configuration of `Go Linter` can be found in the `Tools` section | ||
| of the settings. | ||
|
|
||
| If you are on Windows, you need to install **make** for the above process to complete. | ||
|
|
||
| > **Note** | ||
| When using the make command on Windows, you may receive an `unrecognized command` error for a command that is installed. | ||
| This usually indicates that `PATH` for the binary is not set correctly). | ||
|
|
||
| ### Markdownlint | ||
|
|
||
| We are using [markdownlint](https://github.com/DavidAnson/markdownlint) to ensure consistent styling | ||
| within our Markdown files. | ||
| Specifically we are using [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli). | ||
|
|
||
| We are using `GNU MAKE` to ensure the same functionality locally and within our CI builds. | ||
| This should allow easier debugging and problem resolution. | ||
|
|
||
| #### Markdownlint execution | ||
|
|
||
| To verify that your markdown code conforms to the rules, run the following on your local branch: | ||
|
|
||
| ```shell | ||
| make markdownlint | ||
| ``` | ||
|
|
||
| To use the auto-fix option, run: | ||
|
|
||
| ```shell | ||
| make markdownlint-fix | ||
| ``` | ||
|
|
||
| #### Markdownlint Configuration | ||
|
|
||
| We use the default configuration values for `markdownlint`. | ||
|
|
||
| This means: | ||
|
|
||
| [.markdownlint-cli2.yaml](https://github.com/keptn/lifecycle-toolkit/blob/main/.markdownlint-cli2.yaml) | ||
| contains the rule configuration | ||
|
|
||
| We use the default values, so tools like | ||
| [markdownlint for VSCode](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) | ||
| can be used without additional configuration. |