CONTRIBUTING.md in slack-ruby-client-0.1.0 vs CONTRIBUTING.md in slack-ruby-client-0.2.0

@@ -1,83 +1,82 @@
-# Contributing to Slack
+# Contributing to Slack-Ruby-Client
 
 This project is work of [many contributors](https://github.com/dblock/slack-ruby-client/graphs/contributors).
 
 You're encouraged to submit [pull requests](https://github.com/dblock/slack-ruby-client/pulls), [propose features and discuss issues](https://github.com/dblock/slack-ruby-client/issues).
 
 In the examples below, substitute your Github username for `contributor` in URLs.
 
-## Fork the Project
+### Fork the Project
 
 Fork the [project on Github](https://github.com/dblock/slack-ruby-client) and check out your copy.
 
 ```
 git clone https://github.com/contributor/slack-ruby-client.git
 cd slack-ruby-client
 git remote add upstream https://github.com/dblock/slack-ruby-client.git
 ```
 
-## Bundle Install and Test
+### Bundle Install and Test
 
 Ensure that you can build the project and run tests.
 
 ```
 bundle install
 bundle exec rake
 ```
 
-## Run Slack in Development
+### Run Examples in Development
 
-Create a private slack group for yourself.
+Sign up for Slack, create a private slack group for yourself.
 
 Create a new Bot Integration under [services/new/bot](http://slack.com/services/new/bot).
 
 ![](screenshots/register-bot.png)
 
 On the next screen, note the API token.
 
-Run `SLACK_API_TOKEN=<your API token> foreman start`.
+To run [the example in examples/hi_real_time](examples/hi_real_time/hi.rb), open a terminal, cd into _examples/hi_real_time_, run `bundle install`, followed by `SLACK_API_TOKEN=<your API token> bundle exec ruby hi.rb`.
 
-You can also create a `.env` file with `SLACK_API_TOKEN=<your API token>` and just run `foreman start`.
+## Contribute Code
 
-## Create a Topic Branch
+### Create a Topic Branch
 
 Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
 
 ```
 git checkout master
 git pull upstream master
 git checkout -b my-feature-branch
 ```
 
-## Write Tests
+### Write Tests
 
-Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
-Add to [spec](spec).
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
 
 We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
 
-## Write Code
+### Write Code
 
 Implement your feature or bug fix.
 
-Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop).
-Run `bundle exec rubocop` and fix any style issues highlighted.
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
 
 Make sure that `bundle exec rake` completes without errors.
 
-## Write Documentation
+### Write Documentation
 
 Document any external behavior in the [README](README.md).
 
-## Update Changelog
+### Update Changelog
 
-Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
-Make it look like every other line, including your name and link to your Github account.
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
 
-## Commit Changes
+Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
 
+### Commit Changes
+
 Make sure git knows your name and email address:
 
 ```
 git config --global user.name "Your Name"
 git config --global user.email "[e-mail]"
@@ -88,33 +87,22 @@
 ```
 git add ...
 git commit
 ```
 
-## Push
+### Push
 
 ```
 git push origin my-feature-branch
 ```
 
-## Make a Pull Request
+### Make a Pull Request
 
-Go to https://github.com/contributor/slack-ruby-client and select your feature branch.
-Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+Go to https://github.com/contributor/slack-ruby-client and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
 
-## Rebase
+### Update CHANGELOG Again
 
-If you've been working on a change for a while, rebase with upstream/master.
-
-```
-git fetch upstream
-git rebase upstream/master
-git push origin my-feature-branch -f
-```
-
-## Update CHANGELOG Again
-
 Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
 
 ```
 * [#123](https://github.com/dblock/slack-ruby-client/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
 ```
@@ -124,14 +112,24 @@
 ```
 git commit --amend
 git push origin my-feature-branch -f
 ```
 
-## Check on Your Pull Request
+### Rebase
 
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+### Check on Your Pull Request
+
 Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
 
-## Be Patient
+### Be Patient
 
 It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
 
 ## Thank You