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

Friendlier contributing guide #439

Merged
merged 6 commits into from
Nov 17, 2021
Merged

Friendlier contributing guide #439

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3ae24cb
Use a warmer tone in CONTRIBUTING guide and provide practical help wi…
mattwynne Nov 12, 2021
c15ac22
Update instructions to include golint so you can run `make`
mattwynne Nov 12, 2021
9ee93f2
Update CONTRIBUTING.md
mattwynne Nov 12, 2021
0335f0a
Update README.md
mattwynne Nov 12, 2021
4585818
Update CONTRIBUTING.md
mattwynne Nov 17, 2021
8d3bee2
Remove the need for golint installation instructions
mattwynne Nov 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 28 additions & 17 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,28 @@
## About to contribute?

We appreciate that. But before you do, please learn our basic rules:

* Do you have a feature request? Then don't expect it to be implemented unless
you or someone else sends a [pull request](https://help.github.com/articles/using-pull-requests).
* We love [pull requests](https://help.github.com/articles/using-pull-requests),
but if you don't have a test to go with it we probably won't merge it.
* Before making significant contribution consider discussing the outline of
your solution first. This may avoid a duplication of efforts.

Please do *not* add @author tags - this project embraces collective code
ownership. If you want to know who wrote some code, look in git. When you are
done, send a [pull request](http://help.github.com/send-pull-requests/).
If we get a pull request where an entire file is changed because of
insignificant whitespace changes we cannot see what you have changed, and your
contribution might get rejected.
# Welcome 💖

Before anything else, thank you for taking some of your precious time to help this project move forward. ❤️

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)
to give you a grounding in some of the basic concepts. We want you to feel safe to make mistakes, and ask questions.

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.

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.

## Setup

To get your development environment set up, you'll need to [install Go].

Now install golint:

go install golang.org/x/lint/golint@latest
mattwynne marked this conversation as resolved.
Show resolved Hide resolved

Once that's done, try running the tests:

make
mattwynne marked this conversation as resolved.
Show resolved Hide resolved

If everything passes, you're ready to hack!

[install go]: https://golang.org/doc/install
[community Slack]: https://cucumber.io/community#slack
[raise an issue]: https://github.com/cucumber/godog/issues/new/choose
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,16 +56,16 @@ GO111MODULE=on go get github.com/cucumber/godog/cmd/godog@v0.12.0

## Contributions

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.
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.

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

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.
## Getting help

Reach out to the community on our [Cucumber Slack Community](https://cucumberbdd.slack.com/).
Join [here](https://cucumberbdd-slack-invite.herokuapp.com/).
We have a [community Slack] where you can chat with other users, developers, and BDD practitioners.

Here are some useful channels to try:

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