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

add all make target, reword instructions #335

Merged
merged 2 commits into from Sep 9, 2020
Merged

add all make target, reword instructions #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2630029
add all make target, reword instructions
dmitris Sep 9, 2020
7aa9f85
remove extra line, reword per suggestion
dmitris Sep 9, 2020
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
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Expand Up @@ -6,17 +6,17 @@ Fork, then clone the repo:

```bash
git clone git@github.com:your-username/go-grpc-middleware.git
```
Before submitting a patch, please make sure to run the following make commands for running checks -
Make commands for running formatting/tests/generate proto files/vetting
```
Before submitting a patch, please make sure to run the following make commands to execute the
formatting check, regenerate the proto files, and run the tests and linters:
```powershell
make fmt : Run formatting across all go files

make proto : Generate proto files

make test : Run all the tests

make vet : Run vetting across all go files
make lint : Run linting across all go files
```

One command to rule them all:
Expand All @@ -25,7 +25,7 @@ One command to rule them all:
make all
```

This will `vet`, `fmt`, regenerate documentation and run all tests.
This will `lint`, `fmt`, regenerate proto files and documentation and run all tests.


Push to your fork and open a pull request.
Push to your fork and open a pull request.
4 changes: 3 additions & 1 deletion Makefile
View file
Open in desktop
Expand Up @@ -36,6 +36,8 @@ define require_clean_work_tree

endef

all: fmt proto lint test

.PHONY: fmt
fmt: $(GOIMPORTS)
@echo "Running fmt for all modules: $(MODULES)"
Expand Down Expand Up @@ -65,7 +67,7 @@ test_module:
# --cpu-profile-path string Path to CPU profile output file
# --mem-profile-path string Path to memory profile output file
# to debug big allocations during linting.
lint: ## Runs various static analysis against our code.
lint: ## Runs various static analysis tools against our code.
lint: fmt $(FAILLINT) $(GOLANGCI_LINT) $(MISSPELL)
@echo "Running lint for all modules: $(MODULES)"
./scripts/git-tree.sh
Expand Down