Merge pull request #382 from cucumber/feature/imp-dev-xp-1

Improve developer experience. 

* Closes #378 
* Closes #364 
* Closes #362

.github/ISSUE_TEMPLATE.md

@@ -1,5 +1,7 @@
 ## Summary
 
+<!-- This sections are meant as guidance for you. If some doesn't fit, skip them. In general: Please provide as much information as you can to help us solving your problem -->
+
 <!--- Provide a general summary of the issue in the Title above -->
 
 ## Expected Behavior

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,7 @@
 ## Summary
 
+<!-- This sections are meant as guidance for you. If some doesn't fit, skip them. -->
+
 <!--- Provide a general summary of your changes in the Title above -->
 
 ## Details

.rspec

@@ -1,3 +1,4 @@
 --color
 --format Fuubar
 --order random
+--warnings

CONTRIBUTING.md

@@ -1,5 +1,7 @@
 # Contributing to the Cucumber Aruba Project
 
+## Introduction
+
 We would love to get help from you as "user" and "contributor".
 
 **Users**
@@ -18,7 +20,11 @@ We would love to get help from you as "user" and "contributor".
 
 The rest of this document is a guide for those maintaining Aruba, and others who would like to submit patches.
 
-## Issues
+## Contributing to the "aruba" project
+
+It would be great if all people who want to contribute to the "aruba" project – contributors and maintiners – follow the guidelines in this section. There are also "Getting started"-sections both for [contributors](#getting-started-as-a-contributor) and [maintainers]((#getting-started-as-a-maintainer).
+
+### Issues
 
 We appreciate that. But before you do, please learn our basic rules:
 
@@ -28,19 +34,22 @@ We appreciate that. But before you do, please learn our basic rules:
 * We love [pull requests](https://help.github.com/articles/using-pull-requests). The same here: Please consider our comments within the template we provide for your pull request(s).
 
 
-## Note on Patches/Pull Requests
+### 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 an issue for discussion first
+* Make your feature addition or bug fix – if you're unsure if your addition will be accepted, open an issue for discussion first
 * Make sure your patch is well covered by tests. We don't accept changes that aren't tested.
 * Please do not change the Rakefile, version, or history.
   (if you want to have your own version, that is fine but
   bump version in a commit by itself so we can ignore when we merge your change)
 * Make sure your pull request complies to our development style
 * Rebase your branch if needed to reduce clutter in our git history
-* Make sure you don't break other people's code - On major changes: First deprecated, than bump major version, than make breaking changes
+* Make sure you don't break other people's code – On major changes: First deprecated, than bump major version, than 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**
@@ -50,7 +59,7 @@ We appreciate that. But before you do, please learn our basic rules:
 * Update [History.md](History.md) when a pull request is merged
 * Make sure all tests are green before merging a pull request
 
-## Development style
+### Development style
 
 * We try to follow the recommendations in the [Ruby Community Style Guide](https://github.com/bbatsov/ruby-style-guide) and use [`rubocop`](https://github.com/bbatsov/rubocop) to "enforce" it. Please see [.rubocop.yml](.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`.
@@ -67,20 +76,43 @@ We appreciate that. But before you do, please learn our basic rules:
   7. Use the body to explain what and why vs. how (optional if subject is self-explanatory)
   8. Use Markdown Markup to style your message (only if required)
 
-## Bootstrap environment
+
+## Getting started as a "Contributor"
+
+### Bootstrap environment
 
 To get started with `aruba`, you just need to bootstrap the environment by
 running the following command.
 
-    # Bootstrap environment
-    script/bootstrap
+~~~bash
+# Bootstrap environment
+script/bootstrap
+~~~
+
+### Running tests
+
+Make sure you bootstrap the environment first. Then run the following command
+to run the test suite.
 
-## Running tests
+~~~bash
+# Run the test suite
+script/test
+~~~
+
+If you have problems because our assumptions about your local setup are wrong.
+Try this instead. This requires the `docker`-command/project to be installed on
+your local system.
 
-Make sure you bootstrap the environment first.
+~~~bash
+# Build the docker container
+bundle exec rake docker:build
 
-    # Run the test suite
-    script/test
+# Run the whole test suite in "docker"-container
+RUN_IN_DOCKER=1 script/test
+
+# Run only selected scenario
+RUN_IN_DOCKER=1 script/test cucumber features/steps/command/shell.feature:14
+~~~
 
 ## Installing your own gems used for development
 
@@ -95,22 +127,36 @@ gem 'pry-byebug'
 gem 'byebug'
 ~~~
 
-## Release Process
+## Getting started as a "Maintainer"
+
+### Release Process
 
 * Bump the version number in `lib/aruba/version.rb`
 * Make sure `History.md` is updated with the upcoming version number, and has entries for all fixes.
 * No need to add a `History.md` header at this point - this should be done when a new change is made, later.
 
 Now release it
 
-    bundle update
-    bundle exec rake
-    git commit -m "Release X.Y.Z"
-    rake release
+~~~bash
+# update dependencies
+bundle update
+
+# Run test suite
+script/test
+
+# Release gem
+git commit -m "Version bump"
+script/release
+
+# Merge changes back to have an correct documentation
+git checkout still
+git merge master
+git push
+~~~
 
 Now send a PR to https://github.com/cucumber/website adding an article about the with details of the new release and merge it - an aruba maintainer should normally allowed to merge PRs on `cucumber/website`. A copy of an old announcement can be used as basis for the new article. After this send an email with the link to the article to [email protected]. 
 
-## Gaining Release Karma
+### 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.
 

Dockerfile

@@ -0,0 +1,67 @@
+FROM ubuntu:14.04
+MAINTAINER Aruba Maintainers <[email protected]>
+
+# Packages needed to install RVM and run Bundler gem commands
+RUN apt-get update -qq \
+  && apt-get -y install ca-certificates curl git-core --no-install-recommends \
+  && rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/*.deb /var/cache/apt/archives/partial/*.deb /var/cache/apt/*.bin
+
+# Create guest user early (before rvm) so uid:gid are 1000:000
+RUN useradd -m -s /bin/bash guest
+
+# Temporarily install RVM as root - just for requirements
+RUN gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 \
+  && curl -L get.rvm.io | bash -s stable \
+  && bash -l -c 'rvm requirements 2.2.1' \
+  && bash -l -c 'echo yes | rvm implode' \
+
+# Fix locale
+ENV DEBIAN_FRONTEND noninteractive
+RUN dpkg-reconfigure locales && locale-gen en_US.UTF-8 && /usr/sbin/update-locale LANG=en_US.UTF-8 \
+   && echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && locale-gen
+ENV LC_ALL C.UTF-8
+ENV LANG C.UTF-8
+ENV LANGUAGE C.UTF-8
+
+# Zsh (just for the sake of a handful of Cucumber scenarios)
+RUN apt-get update -qq \
+  && apt-get -y install zsh --no-install-recommends \
+  && rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/*.deb /var/cache/apt/archives/partial/*.deb /var/cache/apt/*.bin
+
+# Python (just for the sake of a handful of Cucumber scenarios)
+RUN apt-get update -qq \
+  && apt-get -y install python --no-install-recommends \
+  && rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/*.deb /var/cache/apt/archives/partial/*.deb /var/cache/apt/*.bin
+
+# Java (for javac - also for just a few Cucumber scenarios)
+RUN apt-get update -qq \
+  && apt-get -y install openjdk-7-jdk --no-install-recommends \
+  && rm -rf /var/lib/apt/lists/* /var/cache/apt/archives/*.deb /var/cache/apt/archives/partial/*.deb /var/cache/apt/*.bin
+
+# Cache needed gems - for faster test reruns
+ADD Gemfile Gemfile.lock aruba.gemspec /home/guest/cache/aruba/
+ADD lib/aruba/version.rb /home/guest/cache/aruba/lib/aruba/version.rb
+RUN chown -R guest:guest /home/guest/cache
+
+USER guest
+ENV HOME /home/guest
+WORKDIR /home/guest
+
+# Install RVM as guest
+RUN gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 \
+  && /bin/bash -l -c "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc" \
+  && curl -L get.rvm.io | bash -s stable \
+  && /bin/bash -l -c "rvm install 2.3.0 && rvm cleanup all" \
+  && /bin/bash -l -c "gem install bundler --no-ri --no-rdoc" \
+  && echo '[[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm"' >> ~/.bashrc \
+  && echo '[[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm"' >> ~/.zshrc
+
+# Download and install aruba + dependencies
+WORKDIR /home/guest/cache/aruba
+RUN bash -l -c "bundle install"
+
+# Default working directory
+RUN mkdir -p /home/guest/aruba
+WORKDIR /home/guest/aruba
+
+CMD ["bundle exec rake test"]

README.md

@@ -5,9 +5,10 @@
 
 Build status:
 
-Linux / OS X  | Windows
-------------- | -------------
-[![Build Status](https://travis-ci.org/cucumber/aruba.svg?branch=master)](https://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/master)
+Version       | Linux / OS X | Windows
+------------- |------------- | -------------
+master | [![Build Status](https://travis-ci.org/cucumber/aruba.svg?branch=master)](https://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/master)
+stil | [![Build Status](https://travis-ci.org/cucumber/aruba.svg?branch=still)](https://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/still)
 
 `aruba` is an extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest" to make testing of commandline applications meaningful, easy and fun.