477135d2fe
* 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 <aurelien.reeves@smartbear.com> * Update README.md Co-authored-by: Aurélien Reeves <aurelien.reeves@smartbear.com> * Update CONTRIBUTING.md Co-authored-by: Viacheslav Poturaev <vearutop@gmail.com> * Remove the need for golint installation instructions Co-authored-by: Aurélien Reeves <aurelien.reeves@smartbear.com> Co-authored-by: Viacheslav Poturaev <vearutop@gmail.com>
24 строки
Без EOL
1,3 КиБ
Markdown
24 строки
Без EOL
1,3 КиБ
Markdown
# 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]. We're currently using version 1.17 for development.
|
|
|
|
Once that's done, try running the tests:
|
|
|
|
make test
|
|
|
|
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 |