README.md in cucumber-1.2.1 vs README.md in cucumber-1.2.2

- old
+ new

@@ -1,40 +1,22 @@ -[![Build Status](https://secure.travis-ci.org/cucumber/cucumber.png)](http://travis-ci.org/cucumber/cucumber) +[![Build Status](https://secure.travis-ci.org/cucumber/cucumber.png)](http://travis-ci.org/cucumber/cucumber) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/cucumber/cucumber) -The main website is at http://cukes.info/ -The documentation is at https://wiki.github.com/cucumber/cucumber/ +# Cucumber -## Note on Patches/Pull Requests +Cucumber is a tool for running automated tests written in plan language. Because they're +written in plan language, they can be read by anyone on your team. Because they can be +read by anyone, you can use them to help improve communication, collaboration and trust on +your team. -* Fork the project. -* Make your feature addition or bug fix. -* Add tests for it. This is important so I don't break it in a - future version unintentionally. -* Commit, do not mess with Rakefile, version, or history. - (if you want to have your own version, that is fine but - bump version in a commit by itself I can ignore when I pull) -* Send me a pull request. Bonus points for topic branches. +Where to get more info: -## Running tests + * The main website: http://cukes.info/ + * Documentation: https://wiki.github.com/cucumber/cucumber/ + * API Documentation: http://cukes.info/api/cucumber/ruby/yardoc/ + * Support forum: https://groups.google.com/forum/?fromgroups#!forum/cukes + * IRC channel: irc://irc.freenode.net/cucumber - gem install bundler - bundle install - rake - -## Release Process - -Before you even attempt to do a release, make sure you can log into cukes.info and touch a file in /var/www/cucumber/api/ruby (see gem_tasks/yard.rake). You need to be able to do this in order to upload YARD docs as part of the release. - -* Bump the version number in `lib/cucumber/platform.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 - rake - git commit -m "Release X.Y.Z" - rake release +See [DEVELOPERS.md](DEVELOPERS.md) for info on contributing to Cucumber. ## Copyright Copyright (c) 2008,2009,2010,2011,2012 Aslak Hellesøy and Contributors. See LICENSE for details.