Skip to content

Commit

Permalink
tweak contributing doc (#135)
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Suderman committed Oct 12, 2020
1 parent 07774dd commit 9731b73
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -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

Expand Down
2 changes: 0 additions & 2 deletions Makefile
Expand Up @@ -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
Expand Down

0 comments on commit 9731b73

Please sign in to comment.