glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-11-16 10:47:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix Makefile install instructions and CONTRIBUTING.md

Browse source
This commit is contained in:
Tom Fleet 2022-10-09 14:21:38 +01:00
parent 212ea40783
commit 2e8acadde1
No known key found for this signature in database
GPG key ID: D36A7A0B5D5AAA95
2 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -37,6 +37,8 @@ If you have questions regarding Cobra, feel free to ask it in the community
### Quick steps to contribute ### Quick steps to contribute
You'll need [golangci-lint] and [richgo] installed in order to run linting and unit tests
1. Fork the project. 1. Fork the project.
1. Download your fork to your PC (`git clone https://github.com/your_username/cobra && cd cobra`) 1. Download your fork to your PC (`git clone https://github.com/your_username/cobra && cd cobra`)
1. Create your feature branch (`git checkout -b my-new-feature`) 1. Create your feature branch (`git checkout -b my-new-feature`)
@ -48,3 +50,5 @@ If you have questions regarding Cobra, feel free to ask it in the community
<!-- Links --> <!-- Links -->
[cobra-slack]: https://gophers.slack.com/archives/CD3LP1199 [cobra-slack]: https://gophers.slack.com/archives/CD3LP1199
[golangci-lint]: https://golangci-lint.run
[richgo]: https://github.com/kyoh86/richgo

5
Makefile
View file

@ -1,12 +1,13 @@
BIN="./bin" BIN="./bin"
SRC=$(shell find . -name "*.go") SRC=$(shell find . -name "*.go")
GOPATH=$(shell go env GOPATH)
ifeq (, $(shell which golangci-lint)) ifeq (, $(shell which golangci-lint))
$(warning "could not find golangci-lint in $(PATH), run: curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh") $(warning "could not find golangci-lint in PATH, run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(GOPATH)/bin v1.50.0")
endif endif
ifeq (, $(shell which richgo)) ifeq (, $(shell which richgo))
$(warning "could not find richgo in $(PATH), run: go install github.com/kyoh86/richgo@latest") $(warning "could not find richgo in PATH, run: go install github.com/kyoh86/richgo@latest")
endif endif
.PHONY: fmt lint test install_deps clean .PHONY: fmt lint test install_deps clean