This project is work of many contributors.
You're encouraged to submit pull requests, propose features and discuss issues.
In the examples below, substitute your Github username for contributor in URLs.
Fork the project on Github 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/slack-ruby/slack-ruby-client.git
Ensure that you can build the project and run tests.
bundle install
bundle exec rake
Sign up for Slack, create a private slack group for yourself.
Create a new Bot Integration under services/new/bot.
On the next screen, note the API token.
To run the example in examples/hi_real_time, 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.
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
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.
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
Implement your feature or bug fix.
Ruby style is enforced with 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.
Slack Web API is updated from https://github.com/slack-ruby/slack-api-ref, a maintained, machine-readable version of Slack API Docs, generated by scraping api.slack.com. To update the Web API from the latest definition run the following Rake task.
rake slack:api:update
Sometimes it's necessary to patch auto-generated Slack Web API methods. For example, we want to help clients with calling to_json on the attachments parameter sent to chat_postMessage. See #20.
Make a change to a generated file, for example lib/slack/web/api/endpoints/chat.rb and generate a patch.
git diff --no-color HEAD lib/slack/web/api/endpoints/chat.rb > lib/slack/web/api/patches/chat.1.patch
Run rake slack:api:update to ensure that the patch is cleanly applied. Implement a test for the added or modified functionality and commit the patch file.
Document any external behavior in the README.
Add a line to CHANGELOG under Next Release. Don't remove Your contribution here.
Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
Make sure git knows your name and email address:
git config --global user.name "Your Name"
git config --global user.email "[email protected]"
Writing good commit logs is important. A commit log should describe what changed and why.
git add ...
git commit
git push origin my-feature-branch
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.
Update the CHANGELOG with the pull request number. A typical entry looks as follows.
* [#123](https://github.com/slack-ruby/slack-ruby-client/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
Amend your previous commit and force push the changes.
git commit --amend
git push origin my-feature-branch -f
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
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.
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!
Please do know that we really appreciate and value your time and work. We love you, really.