From 5c841e22ab8a71cb305fd97ebc513e2b959e6b79 Mon Sep 17 00:00:00 2001 From: Ryan Date: Mon, 9 Aug 2021 16:07:26 +0000 Subject: [PATCH] Update docs, file formatting and docker images (#766) * docs: fix wrong licence link * fix: add more formatting settings, reformat all feat: add vscode extensions recommendations * docs: update contributing documentation * fix: remove unnecessary comment it was due to broken checkout * docs: rework installation section it has been brought up few times, new style should be easier to understand * docs: update images provided by catthehacker * docs: replace 18.04 with recent image * fix: add final new line --- .editorconfig | 12 ++++ .github/ISSUE_TEMPLATE/feature_template.md | 2 +- .github/ISSUE_TEMPLATE/issue_template.md | 2 +- .github/actions/choco/action.yml | 2 +- .github/actions/composite/action.yml | 2 +- .github/actions/composite/script.sh | 2 +- .github/workflows/release.yml | 2 +- .github/workflows/stale.yml | 30 +++++----- .gitignore | 3 +- .mergify.yml | 24 ++++---- .prettierignore | 2 + .prettierrc.yml | 7 +++ .vscode/extensions.json | 9 +++ .vscode/settings.json | 15 +++-- CONTRIBUTING.md | 70 +++++++++++----------- IMAGES.md | 40 ++++--------- LICENSE | 2 +- Makefile | 16 ++++- README.md | 70 +++++++++++++--------- cmd/root.go | 6 +- codecov.yml | 2 +- 21 files changed, 186 insertions(+), 134 deletions(-) create mode 100644 .prettierignore create mode 100644 .prettierrc.yml create mode 100644 .vscode/extensions.json diff --git a/.editorconfig b/.editorconfig index 4e61e809..07a45c4f 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,4 +1,16 @@ +root = true + +[*] +end_of_line = lf +charset = utf-8 +insert_final_newline = true +trim_trailing_whitespace = true + # Override for Makefile [{Makefile, makefile, GNUmakefile}] indent_style = tab indent_size = 4 + +[*.{yml.yaml,json}] +indent_style = space +indent_size = 2 diff --git a/.github/ISSUE_TEMPLATE/feature_template.md b/.github/ISSUE_TEMPLATE/feature_template.md index 2a24ebb9..533e8af4 100644 --- a/.github/ISSUE_TEMPLATE/feature_template.md +++ b/.github/ISSUE_TEMPLATE/feature_template.md @@ -3,7 +3,7 @@ name: Feature request about: Use this template for requesting a feature/enhancement. title: "Enhancement: " labels: "kind/feature-request" -assignees: '' +assignees: "" --- ## Describe feature diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md index 6712e111..85a73bb6 100644 --- a/.github/ISSUE_TEMPLATE/issue_template.md +++ b/.github/ISSUE_TEMPLATE/issue_template.md @@ -3,7 +3,7 @@ name: Issue about: Use this template for reporting a bug/issue. title: "Issue: " labels: kind/bug -assignees: '' +assignees: "" --- - -[hub/catthehacker/alpine]: https://hub.docker.com/r/catthehacker/alpine -[hub/catthehacker/alpine/act/size]: https://img.shields.io/docker/image-size/catthehacker/alpine/act -