Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

tweak contributing doc #135

Merged
merged 1 commit into from Oct 12, 2020
Merged

tweak contributing doc #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
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
View file
Open in desktop
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