From 9731b733377fdbc50f3be9fb1e87bfcfbc66f754 Mon Sep 17 00:00:00 2001 From: Andrew Suderman Date: Mon, 12 Oct 2020 12:27:44 -0600 Subject: [PATCH] tweak contributing doc (#135) --- CONTRIBUTING.md | 8 ++++++-- Makefile | 2 -- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9563adb..23c7bab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,15 +18,19 @@ rbac-lookup is a relatively simple cobra cli tool that looks up information abou We label issues with the ["good first issue" tag](https://github.com/FairwindsOps/rbac-lookup/labels/good%20first%20issue) if we believe they'll be a good starting point for new contributors. If you're interested in working on an issue, please start a conversation on that issue, and we can help answer any questions as they come up. ## Setting Up Your Development Environment + ### Prerequisites -* A properly configured Golang environment with Go 1.11 or higher + +* A properly configured Golang environment with Go 1.13 or higher * Access to a cluster via a properly configured KUBECONFIG ### Installation + * Install the project with `go get github.com/fairwindsops/rbac-lookup` * Change into the rbac-lookup directory which is installed at `$GOPATH/src/github.com/fairwindsops/rbac-lookup` * Use `make build` to build the binary locally. -* Use `make tests` to run the tests and generate a coverage report. +* Use `make test` to run the tests and generate a coverage report. +* Use `make lint` to run [golangci-lint](https://github.com/golangci/golangci-lint) (requires golangci-lint installed) ## Creating a New Issue diff --git a/Makefile b/Makefile index d45b092..2a6167c 100644 --- a/Makefile +++ b/Makefile @@ -11,8 +11,6 @@ all: test build build: $(GOBUILD) -o $(BINARY_NAME) -ldflags "-X main.version=$(VERSION) -X main.commit=$(COMMIT) -s -w" -v test: - printf "Linter:\n" - $(GOCMD) list ./... | xargs -L1 golint | tee golint-report.out printf "\n\nTests:\n\n" $(GOCMD) test -v --bench --benchmem -coverprofile coverage.txt -covermode=atomic ./... $(GOCMD) vet ./... 2> govet-report.out