Please follow these guidelines if you want to contribute to Cucumber or help the Cucumber team reproduce a problem.
Before you get in touch, try searching the mailing list for similar questions and possible solutions. Or have a look on StackOverflow. 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.
We use GitHub issues to track bugs and feature requests exclusively. Please use the support forums for questions and discussions.
Before you file an Issue on Github, make sure you have tried the latest version. This way you don’t waste time by reporting a bug that has already been fixed.Try the latest released gem:
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.
You will likely use Cucumber combined with various web frameworks, many different dependencies and your own code. You can run 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:
- 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
Feed Cucumber with
--backtrace --verboseand rake with
- What your expected output is.
- What relevant code you have. Don’t describe your code; show your actual code. You can use https://gist.github.com/, 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 (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.
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.
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.
If you would like to contribute to the documentation, please see Contributing to documentation.
If you enjoy using Cucumber, consider Investing in Cucumber.