Skip to content

Latest commit

 

History

History
260 lines (195 loc) · 8.3 KB

CONTRIBUTING.md

File metadata and controls

260 lines (195 loc) · 8.3 KB
Raw

Contributing to the Cucumber Aruba Project

Introduction

We would love to get help from you as a user and a contributor.

As a User

  • Tell us how "Aruba" works for you
  • Spread the word if you like our work and please tell us if something is (utterly) wrong
  • Encourage people in testing their code and keep communicating their needs

As a Contributor

  • Send us bug fixes
  • Add new features to the code
  • Discuss changes
  • Add missing documentation
  • Improve our test coverage

The rest of this document is a guide for those maintaining Aruba, and others who would like to submit patches.

Contributing to the Aruba project

It would be great if all people who want to contribute to the Aruba project — contributors and maintainers — follow the guidelines in this section. There are also "Getting started" sections both for contributors and maintainers.

Issues

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 submits a pull request. It might be better to start a discussion on the Google Group.
  • Reporting a bug? Follow our comments in the Issue Template, which is pre-filled when you create the new GitHub Issue.
  • We love pull requests. The same here: Please consider our comments within the pull request template.

Pull Requests

Contributors

Please...

  • Fork the project. Make a branch for your change.
  • Make your feature addition or bug fix — if you're unsure if your addition will be accepted, open a GitHub Issue for discussion first
  • Make sure your patch is well covered by tests. We don't accept changes that aren't tested.
  • Do not change the Rakefile, gem version number in version.rb, or CHANGELOG.md. (If you want to have your own version, that is fine but bump version in a separate commit, so that we can ignore that commit when we merge your change.)
  • Make sure your pull request complies with our development style guidelines.
  • Rebase your branch if needed. This reduces clutter in our git history.
  • Make sure you don't break other people's code. On major changes: First deprecate, then bump major version, then make breaking changes,
  • Split up your changes into reviewable git commits which combine all lines/files relevant for a single change.
  • Send us a pull request.

Maintainers

  • Use pull requests for larger or controversial changes made by yourself or changes you might expected to break the build.
  • Commit smaller changes directly to main, e.g. fixing typos, adding tests or adding documentation.
  • Update CHANGELOG.md when a pull request is merged.
  • Make sure all tests are green before merging a pull request.

Development style guidelines

  • We try to follow the recommendations in the Ruby Community Style Guide and use rubocop to "enforce" it. Please see .rubocop.yml for exceptions.
  • There should be action methods and getter methods in Aruba. Only the latter should return values. Please expect the first ones to return nil.
  • Add documentation — aka acceptance tests — for new features using Aruba's Cucumber steps. Place them somewhere suitable in features/.
  • Add unit tests where needed to cover edge cases which are not (directly) relevant for users.
  • Add YARD developer documentation to all relevant methods added.
  • Format your commit messages following these seven rules — see the "How to Write a Git Commit Message" blog post for a well-written explanation about the why.
    1. Separate subject from body with a blank line
    2. Limit the subject line to 50 characters
    3. Capitalize the subject line
    4. Do not end the subject line with a period
    5. Use the imperative mood in the subject line
    6. Wrap the body at 72 characters
    7. Use the body to explain what and why vs. how (optional if subject is self-explanatory)

Getting started as a "Contributor"

Requirements

To get started with Aruba, you only need Bundler.

Install Aruba's dependencies:

bundle install

Running tests

Run the following command to run the test suite.

# Run the whole test suite
bundle exec rake
# Run RSpec tests
bundle exec rake spec
# Run Cucumber features
bundle exec rake cucumber
# Run Cucumber features which are "WORK IN PROGRESS" and are allowed to fail
bundle exec rake cucumber:wip

If you have problems because our assumptions about your local setup are wrong, perhaps you can use this Docker workflow. This requires Docker to be installed on your local system.

# Build the docker container
docker build -t test-aruba .

# Open a bash shell inside the container with attached volume so changes to the
# code will be picked up automatically.
docker run -v $PWD:/aruba --rm -it test-aruba:latest bash

# Run the test suite
bundle exec rake

If you want to run the test suite against specific versions of Aruba's dependencies, you can use appraisal:

bundle exec appraisal cucumber_6 bundle install
bundle exec appraisal cucumber_6 bundle exec rake

Installing your own gems used for development

A Gemfile.local file can be used, to have your own gems installed to support your normal development workflow.

Example Gemfile.local:

gem 'pry-byebug'
gem 'byebug'

Running a developer console

The interactive Aruba console starts an IRB console with Aruba's API loaded:

bin/console

Linting

Aruba's Rakefile provides the following linting tasks

bundle exec rake lint                         # Run all linters
bundle exec rake lint:coding_guidelines       # Lint our code with "rubocop"
bundle exec rake lint:licenses                # Check for relevant licenses in project

Building and installing your local Aruba version

You can use the following Rake tasks to build and install your work-in-progress locally:

# Build your copy
bundle exec rake build
# Build and install your copy
bundle exec rake install
# Build and install your copy without network access
bundle exec rake install:local

Getting started as a "Maintainer"

Release Process

  • Bump the version number in lib/aruba/version.rb
  • Make sure CHANGELOG.md is updated with the upcoming version number, and has entries for all fixes.
  • No need to add a CHANGELOG.md header at this point - this should be done later, when a new change is made.

Now release it:

# update dependencies
bundle update

# Run test suite
bundle exec rake

# Release gem
git commit -m "Version bump"
bundle exec rake release

Now send a PR to cucumber/website adding an article with details of the new release. Then merge it - an aruba maintainer should normally be allowed to merge PRs on cucumber/website. A copy of an old announcement can be used as basis for the new article.

Now, send an email with the link to the article to [email protected].

Gaining Release Karma

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

Current release managers:

To grant release karma, issue the following command:

gem owner aruba --add <NEW OWNER RUBYGEMS EMAIL>