Contributing to SlackRubyBot

April 27, 2020 · View on GitHub

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

Fork the project on Github and check out your copy.

git clone https://github.com/contributor/slack-ruby-bot.git
cd slack-ruby-bot
git remote add upstream https://github.com/slack-ruby/slack-ruby-bot.git

Bundle Install and Test

Ensure that you can build the project and run tests. Make sure you have set CONCURRENCY env variable to one of the following: celluloid-io, faye-websocket or async-websocket.

export CONCURRENCY=async-websocket
bundle install
bundle exec rake

Take a look at the travis configuration for more details.

Run SlackRubyBot in Development

Create a private slack group for yourself.

Create a new Bot Integration under services/new/bot.

On the next screen, note the API token.

Run SLACK_API_TOKEN=<your API token> foreman start.

You can also create a .env file with SLACK_API_TOKEN=<your API token> and just run foreman start.

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

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.

We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.

Write Code

Implement your feature or bug fix.

Ruby style is enforced with Rubocop. Run bundle exec rubocop and fix any style issues highlighted.

Make sure that bundle exec rake completes without errors.

Write Documentation

Document any external behavior in the README.

Update Changelog

Add a line to CHANGELOG under Next Release. Make it look like every other line, including 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 "contributor@example.com"

Writing good commit logs is important. A commit log should describe what changed and why.

git add ...
git commit

Push

git push origin my-feature-branch

Make a Pull Request

Go to https://github.com/contributor/slack-ruby-bot 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

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 with the pull request number. A typical entry looks as follows.

* [#123](https://github.com/slack-ruby/slack-ruby-bot/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