From 283ed1c50078fddc8dd6aa9a957a7aad0134722f Mon Sep 17 00:00:00 2001 From: Spolti Date: Mon, 9 Jan 2023 17:12:57 -0300 Subject: [PATCH] remove contributors_guide.md file Signed-off-by: Spolti --- CONTRIBUTORS_GUIDE.md | 53 ------------------------------------------- 1 file changed, 53 deletions(-) delete mode 100644 CONTRIBUTORS_GUIDE.md diff --git a/CONTRIBUTORS_GUIDE.md b/CONTRIBUTORS_GUIDE.md deleted file mode 100644 index e604bd0..0000000 --- a/CONTRIBUTORS_GUIDE.md +++ /dev/null @@ -1,53 +0,0 @@ -# Contributors Guide - -This guide aims to guide newcomers to getting started with the project standards. - - -## Code Style - -For this project we use basically the default configuration for most used IDEs. -For the configurations below, make sure to properly configure your IDE: - -- **imports**: goimports - -This should be enough to get you started. - -If you are unsure that your IDE is not correctly configured, you can run the lint checks: - -```bash -make lint -``` - -If something goes wrong, the error will be printed, e.g.: -```bash -$ make lint -make addheaders -make fmt -./hack/go-lint.sh -util/floatstr/floatstr_test.go:19: File is not `goimports`-ed (goimports) - "k8s.io/apimachinery/pkg/util/yaml" -make: *** [lint] Error 1 -``` - -Lint issues can be fixed with the `--fix` flag, this command can be used: -```bash -make lint params=--fix -``` - - -### EditorConfig -For IntelliJ you can find an example `editorconfig` file [here](contrib/intellij.editorconfig). To use it please visit -the Jetbrains [documentation](https://www.jetbrains.com/help/idea/editorconfig.html). - - -## Known Issues - -On MacOSX/darwin you might get this issue: -``` - goimports: can't extract issues from gofmt diff output -``` -To solve install the `diffutils` package: - -```bash - brew install diffutils -``` \ No newline at end of file