Skip to content

Commit 3ffbf8b

Browse files
grosseronsi
authored andcommitted
add makefile
1 parent d80eebe commit 3ffbf8b

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

CONTRIBUTING.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ Your contributions to Ginkgo are essential for its long-term maintenance and imp
66
- Ensure adequate test coverage:
77
- When adding to the Ginkgo library, add unit and/or integration tests (under the `integration` folder).
88
- When adding to the Ginkgo CLI, note that there are very few unit tests. Please add an integration test.
9-
- Make sure all the tests succeed via `ginkgo -r -p`
10-
- Vet your changes via `go vet ./...`
11-
- Update the documentation. Ginkgo uses `godoc` comments and documentation in `docs/index.md`. You can run `bundle exec jekyll serve` in the `docs` directory to preview your changes.
9+
- Run `make` or:
10+
- Install ginkgo locally via `go install ./...`
11+
- Make sure all the tests succeed via `ginkgo -r -p`
12+
- Vet your changes via `go vet ./...`
13+
- Update the documentation. Ginkgo uses `godoc` comments and documentation in `docs/index.md`. You can run `bundle && bundle exec jekyll serve` in the `docs` directory to preview your changes.
1214

1315
Thanks for supporting Ginkgo!

Makefile

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# default task since it's first
2+
.PHONY: all
3+
all: install vet test
4+
5+
.PHONY: install
6+
install:
7+
which ginkgo 2>&1 >/dev/null || go install ./...
8+
9+
.PHONY: test
10+
test:
11+
ginkgo -r -p
12+
13+
.PHONY: vet
14+
vet:
15+
go vet ./...

0 commit comments

Comments
 (0)