Skip to content

Commit 477135d

Browse files
mattwynneaurelien-reevesvearutop
authored
Friendlier contributing guide (#439)
* Use a warmer tone in CONTRIBUTING guide and provide practical help with getting up and running. * Update instructions to include golint so you can run `make` * Update CONTRIBUTING.md Co-authored-by: Aurélien Reeves <[email protected]> * Update README.md Co-authored-by: Aurélien Reeves <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Viacheslav Poturaev <[email protected]> * Remove the need for golint installation instructions Co-authored-by: Aurélien Reeves <[email protected]> Co-authored-by: Viacheslav Poturaev <[email protected]>
1 parent 86a5635 commit 477135d

File tree

3 files changed

+39
-26
lines changed

3 files changed

+39
-26
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
1-
## About to contribute?
2-
3-
We appreciate that. But before you do, please learn our basic rules:
4-
5-
* Do you have a feature request? Then don't expect it to be implemented unless
6-
you or someone else sends a [pull request](https://help.github.com/articles/using-pull-requests).
7-
* We love [pull requests](https://help.github.com/articles/using-pull-requests),
8-
but if you don't have a test to go with it we probably won't merge it.
9-
* Before making significant contribution consider discussing the outline of
10-
your solution first. This may avoid a duplication of efforts.
11-
12-
Please do *not* add @author tags - this project embraces collective code
13-
ownership. If you want to know who wrote some code, look in git. When you are
14-
done, send a [pull request](http://help.github.com/send-pull-requests/).
15-
If we get a pull request where an entire file is changed because of
16-
insignificant whitespace changes we cannot see what you have changed, and your
17-
contribution might get rejected.
1+
# Welcome 💖
2+
3+
Before anything else, thank you for taking some of your precious time to help this project move forward. ❤️
4+
5+
If you're new to open source and feeling a bit nervous 😳, we understand! We recommend watching [this excellent guide](https://egghead.io/talks/git-how-to-make-your-first-open-source-contribution)
6+
to give you a grounding in some of the basic concepts. We want you to feel safe to make mistakes, and ask questions.
7+
8+
If anything in this guide or anywhere else in the codebase doesn't make sense to you, please let us know! It's through your feedback that we can make this codebase more welcoming, so we'll be glad to hear thoughts.
9+
10+
You can chat with us in the [#committers-go](https://cucumberbdd.slack.com/archives/CA5NJPDJ4) channel in our [community Slack], or feel free to [raise an issue] if you're experiencing any friction trying make your contribution.
11+
12+
## Setup
13+
14+
To get your development environment set up, you'll need to [install Go]. We're currently using version 1.17 for development.
15+
16+
Once that's done, try running the tests:
17+
18+
make test
19+
20+
If everything passes, you're ready to hack!
21+
22+
[install go]: https://golang.org/doc/install
23+
[community Slack]: https://cucumber.io/community#slack
24+
[raise an issue]: https://github.com/cucumber/godog/issues/new/choose

Makefile

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@
22

33
VERS := $(shell grep 'const Version' -m 1 godog.go | awk -F\" '{print $$2}')
44

5-
test:
5+
EXPECTED_GO_VERSION = 1.17
6+
check-go-version:
7+
@[[ "$(shell go version)" =~ $(EXPECTED_GO_VERSION) ]] || (echo Wrong go version! Please install $(EXPECTED_GO_VERSION) && exit 1)
8+
9+
test: check-go-version
610
@echo "running all tests"
711
@go install ./...
812
@go fmt ./...
9-
@golint github.com/cucumber/godog
10-
@golint github.com/cucumber/godog/cmd/godog
13+
@go run golang.org/x/lint/golint@latest github.com/cucumber/godog
14+
@go run golang.org/x/lint/golint@latest github.com/cucumber/godog/cmd/godog
1115
go vet ./...
1216
go test -race
1317
godog -f progress -c 4

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,16 @@ GO111MODULE=on go get github.com/cucumber/godog/cmd/[email protected]
5656

5757
## Contributions
5858

59-
Godog is a community driven Open Source Project within the Cucumber organization, it is maintained by a handfull of developers, but we appreciate contributions from everyone.
59+
Godog is a community driven Open Source Project within the Cucumber organization. We [welcome contributions from everyone](https://cucumber.io/blog/open-source/tackling-structural-racism-(and-sexism)-in-open-so/), and we're ready to support you if you have the enthusiasm to contribute.
6060

61-
If you are interested in developing Godog, we suggest you to visit one of our slack channels.
61+
See the [contributing guide] for more detail on how to get started.
6262

63-
Feel free to open a pull request. Note, if you wish to contribute larger changes or an extension to the exported methods or types, please open an issue before and visit us in slack to discuss the changes.
63+
## Getting help
6464

65-
Reach out to the community on our [Cucumber Slack Community](https://cucumberbdd.slack.com/).
66-
Join [here](https://cucumberbdd-slack-invite.herokuapp.com/).
65+
We have a [community Slack] where you can chat with other users, developers, and BDD practitioners.
66+
67+
Here are some useful channels to try:
6768

68-
### Popular Cucumber Slack channels for Godog:
6969
- [#help-godog](https://cucumberbdd.slack.com/archives/CTNL1JCVA) - General Godog Adoption Help
7070
- [#committers-go](https://cucumberbdd.slack.com/archives/CA5NJPDJ4) - Golang focused Cucumber Contributors
7171
- [#committers](https://cucumberbdd.slack.com/archives/C62D0FK0E) - General Cucumber Contributors
@@ -602,3 +602,5 @@ A simple example can be [found here](/_examples/custom-formatter).
602602
[behat]: http://docs.behat.org/ "Behavior driven development framework for PHP"
603603
[cucumber]: https://cucumber.io/ "Behavior driven development framework"
604604
[license]: https://en.wikipedia.org/wiki/MIT_License "The MIT license"
605+
[contributing guide]: https://github.com/cucumber/godog/blob/main/CONTRIBUTING.md
606+
[community Slack]: https://cucumber.io/community#slack

0 commit comments

Comments
 (0)