From d4569f7736616d21401c46b783bbd427367561fc Mon Sep 17 00:00:00 2001 From: Matt Wynne Date: Thu, 9 May 2024 08:50:51 -0700 Subject: [PATCH] Update contributing.md Friendlier tone; less noise. --- content/docs/community/contributing.md | 57 ++++---------------------- 1 file changed, 9 insertions(+), 48 deletions(-) diff --git a/content/docs/community/contributing.md b/content/docs/community/contributing.md index c4b41d07..f24a43e9 100644 --- a/content/docs/community/contributing.md +++ b/content/docs/community/contributing.md @@ -9,61 +9,22 @@ polyglot: weight: 30 --- -Please follow these guidelines if you want to contribute to Cucumber or help the Cucumber team reproduce a problem. +You want to contribute to Cucumber, great! # You have a question -Before you [get in touch](/docs/community/get-in-touch), try searching the [mailing list](https://groups.google.com/forum/#!forum/cukes) for similar questions and possible solutions. -Or have a look on [StackOverflow](https://stackoverflow.com/questions/tagged/cucumber). Similar questions come up now and again. You might be able to find the answer yourself. - -It's impossible to give a meaningful answer to "Cucumber doesn't work - what's wrong?" -style questions. You have to tell us [more](#help-us-help-you). - -We use GitHub issues to track bugs and feature requests exclusively. Please use the [support forums](/docs/community/get-in-touch) for questions and discussions. +You can [get in touch](/docs/community/get-in-touch) or have a look on [StackOverflow](https://stackoverflow.com/questions/tagged/cucumber). Similar questions come up now and again. You might be able to find the answer yourself. # You have found a bug -Before you file an [Issue on Github](https://github.com/cucumber/cucumber/issues/), make sure you have tried the latest version. -This way you don't waste time by reporting a bug that has already been fixed. - -{{% text "ruby" %}}Try the latest released gem:{{% /text %}} - -``` ruby -gem update cucumber -``` - -If you are certain you have found a bug, register a ticket with the relevant project. We have added issue templates on GitHub to help you provide the relevant information. -If you're not sure, please [get in touch](/docs/community/get-in-touch). - -## Help us help you - -You will likely use Cucumber combined with various web frameworks, many different dependencies and your own code. -You can [run Cucumber](/docs/cucumber/api/#running-cucumber) in different ways, and many things can go wrong - and quite often it has nothing to do with Cucumber at all. - -The only way we can fix a bug is to reproduce it first. If reproducing the bug requires setting up a project, please write a Cucumber Feature that demonstrates the bug. When you have done that, mention it in your Issue or send a Pull Request. - -When asking a question, or filing a bug report, please tell us: - -- Which version of Cucumber you are using: `cucumber --version`. -- Any other dependencies you have. -- How you are running Cucumber and which options you provided (i.e. which commands you ran) -- What the output, error message and full {{% text "ruby" %}}backtrace{{% /text %}}{{% text "java,kotlin,javascript" %}}stacktrace{{% /text %}} was. -{{% text "ruby" %}}Feed Cucumber with `--backtrace --verbose` and rake with `--trace`.{{% /text %}} -- What your expected output is. -- What relevant code you have. Don't *describe* your code; show your actual code. You can use , rather than pasting code in emails. - -The only way to fix a bug, is to reproduce it first. At the very least, provide the steps to reproduce the issue. -If you can, write a Unit Test or a Cucumber Feature that demonstrates the bug. -On occasion, we might ask you to provide a [Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve) (preferably in the form of a Github project). - -If you file a Github issue without following these guidelines, your ticket may be closed. If that happens, please provide the missing information in the ticket to have it reopened. - -Whenever possible, please provide a Pull Request yourself that fixes the issue and/or consider adding your solution to the documentation. - -# You want a new feature +There are several different flavours of Cucumber for different programming languages. Try to file your issue in the repo for the Cucumber flavour you're using: -Start by creating a ticket. Then, create a Cucumber Feature and start implementing it. It also helps if you add unit tests for the low level code. +* [Cucumber JVM](https://github.com/cucumber/cucumber-jvm/issues/new) +* [Cucumber JS](https://github.com/cucumber/cucumber-js/issues/new) +* [Cucumber Ruby](https://github.com/cucumber/cucumber-ruby/issues/new) +* [Godog](https://github.com/cucumber/godog/issues/new) -If you want to discuss your feature and possible solution, you can do so in the GitHub issue, or on one of the [support forums](/docs/community/get-in-touch). +If you're not sure, open an issue in the [common](https://github.com/cucumber/common/issues/new/choose) repo, and we'll take it from there. # You want to update the documentation @@ -71,4 +32,4 @@ If you would like to contribute to the documentation, please see [Contributing t # You want to contribute but don't know how -If you enjoy using Cucumber, consider [Investing in Cucumber](https://cucumber.io/blog/2017/10/03/invest-in-cucumber). +If you enjoy using Cucumber, consider [sponsoring us](https://github.com/sponsors/cucumber).