Skip to content

Commit

Permalink
Report changes from 414a139 in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aurelien-reeves committed Jun 24, 2021
1 parent b21c74e commit 21db4d2
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ the Cucumber [code of conduct](https://cucumber.io/conduct).

## How can I contribute?

If you read this, you are certainly looking to contribute to the code. Cucumber
If you're reading this, you are certainly looking to contribute to the code. Cucumber
is not this single repository. It is made up of several packages around several
repositories. So before going further with the code, you may consider the
following first, in order to get your bearings.
Expand All @@ -25,12 +25,13 @@ If you want to report an issue, or suggest an enhancement, go to

### Meet the community, the maintainers, and other Cucumber developers

Smartbear is hosting a [community message board].
Smartbear hosts a [community message board].
This is a good place to meet users, the community, and to ask questions.

You can also join the Cucumber Community Slack team:
You can also join the Cucumber Community Slack:
[register for an account][register-slack] then head over to [#intro][slack-intro].
This is the place to be to meet the maintainers aka the core team.
This is the place to be to meet other contributors and find a mentor to help you
get started.

### Test Cucumber

Expand Down Expand Up @@ -59,11 +60,11 @@ publication and to discover new ones.
The short version is:

- Find the appropriate repository
- Make sure there is not already an issue or pull request that deals with your
bug or request
- Consider submitting a pull request if you feel confident enough
- Try to check there is not already an issue or pull request that deals with
your bug or request
- Explain your issue and include as much details as possible to help other
people reproduce your problem or understand your request
- Consider submitting a pull request if you feel confident enough

You can find more details for each of these steps in the following sections.

Expand Down Expand Up @@ -98,15 +99,18 @@ repository - `cucumber-ruby` - and the mono-repo at [cucumber/common].

Search in [the current repository][cucumber-ruby-issues], in the
[mono-repo][cucumber/common-issues], but also in the
[whole cucumber team][cucumber-issues] if the problem or feature has already
[whole cucumber organization][cucumber-issues] if the problem or feature has already
been reported. If you find an issue or pull request which is still open, add
comments to it instead of opening a new one.

If you're not sure, don't hesitate to just open a new issue. We can always merge
and de-duplicate later.

### Submitting a pull request

When submitting a pull request:

- create a draft pull request
- create a [draft pull request][how-to-create-a-draft-pr]
- try to follow the instructions in the [template](.github/PULL_REQUEST_TEMPLATE.md)
- if possible, [sign your commits]
- update CHANGELOG.md with your changes
Expand All @@ -125,8 +129,9 @@ Please do your best to create a [minimal, reproducible example][minimal-reproduc
Consider submitting a pull request. Even if you think you cannot fix it by
yourself, a pull request with a failing test is always welcome.

If you request for an enhancement - a new feature, be specific, support your
request with referenced facts and include examples to illustrate your proposal.
If you request is for an enhancement - a new feature - try to be specific and
support your request with referenced facts and include examples to illustrate
your proposal.

## Contribute to the code

Expand All @@ -136,9 +141,9 @@ Development environment for `cucumber-ruby` is a simple Ruby environment with
Bundler. Use a [supported Ruby version](./README.md#supported-platforms), make
sure [Bundler] is set-up, and voilà!

You can then fork and clone the repository. If your environment is set-up
properly, the following commands should install the dependencies and execute all
the tests successfully.
You can then [fork][how-to-fork] and clone the repository. If your environment
is set-up properly, the following commands should install the dependencies and
execute all the tests successfully.

```shell
bundle install
Expand Down Expand Up @@ -236,6 +241,8 @@ You can find additional documentation in the [docs](./docs) directory such as
[cucumber-ruby-issues]: https://github.com/cucumber/cucumber-ruby/search?q=is%3Aissue
[cucumber/common-issues]: https://github.com/cucumber/common/search?q=is%3Aissue
[cucumber-issues]: https://github.com/search?q=is%3Aissue+user%3Acucumber
[how-to-create-a-draft-pr]: https://docs.github.com/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests
[how-to-fork]: https://docs.github.com/github/collaborating-with-pull-requests/working-with-forks/about-forks
[sign your commits]: https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification/signing-commits
[minimal-reproducible-example]: https://stackoverflow.com/help/minimal-reproducible-example
[RVM]: https://rvm.io/
Expand Down

0 comments on commit 21db4d2

Please sign in to comment.