Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (46 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

63 lines (46 loc) · 2.87 KB

About to create a new Github Issue?

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

  • This is not a support forum. If you have a question, please go to The Cukes Google Group.
  • Do you have an idea for a new feature? Then don't expect it to be implemented unless you or someone else sends a pull request. You might be better to start a discussion on the google group.
  • Reporting a bug? Please tell us:
    • which version of Cucumber you're using
    • which version of Ruby you're using.
    • How to reproduce it. Bugs with a failing test in a pull request get fixed much quicker. Some bugs may never be fixed.
  • Want to paste some code or output? Put ``` on a line above and below your code/output. See GFM's Fenced Code Blocks for details.
  • We love pull requests. But if you don't have a test to go with it we probably won't merge it.

Contributing to cucumber-rails

This document is a guide for those maintaining Cucumber-Rails, and others who would like to submit patches.

Note on Patches/Pull Requests

  • Fork the project. Make a branch for your change.
  • Make your feature addition or bug fix.
  • Make sure your patch is well covered by tests. We don't accept changes to cucumber-rails that aren't tested.
  • Please do not change the Rakefile, version, or CHANGELOG.
  • Send us a pull request.

Running tests

gem install bundler
bundle install
bin/install_geckodriver.sh
bin/install_webpacker.sh
# Then to run tests on one specific gemfile (i.e. Rails 4.2), run
bundle exec appraisal rails_4_2 rake test
# Or run tests across the full supported stack. Note that because we support many versions. This takes 5-10 minutes
bundle exec rake appraisal

Release Process

  • Make sure CHANGELOG.md is updated with the upcoming version number, and has entries for all fixes.
  • No need to add a new version header at this point - this should be done when a new release is made, later.
  • Make sure you have up-to-date and clean copy of cucumber/cucumber.github.com.git at the same level as cucumber repo.

Now release it

bundle update
bundle exec rake
git commit -m "Release X.Y.Z"
rake release

Gaining Release Karma

To become a release manager, create a pull request adding your name to the list below, including your Rubygems email address in the ticket. One of the existing Release managers will then add you.

Current release managers:

  • Kosmas Chatzimichalis
  • Matt Wynne
  • Mathieu Jobin
  • Andrew Walter

To grant release karma, issue the following command:

gem owner cucumber-rails --add <NEW OWNER RUBYGEMS EMAIL>