From b0091ac6d059a4da363f32b86d785a63d5366a56 Mon Sep 17 00:00:00 2001 From: dblock Date: Fri, 19 Jun 2015 13:44:26 -0400 Subject: [PATCH] Clarified deployment vs. development. --- CONTRIBUTING.md | 32 +++++++++++++++++++++++--------- DEPLOYMENT.md | 2 +- README.md | 12 ------------ 3 files changed, 24 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f817934..e698334 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,23 +16,37 @@ cd slack-mathbot git remote add upstream https://github.com/dblock/slack-mathbot.git ``` -## Create a Topic Branch +## Bundle Install and Test -Make sure your fork is up-to-date and create a topic branch for your feature or bug fix. +Ensure that you can build the project and run tests. ``` -git checkout master -git pull upstream master -git checkout -b my-feature-branch +bundle install +bundle exec rake ``` -## Bundle Install and Test +## Run SlackMathbot in Development -Ensure that you can build the project and run tests. +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= foreman start`. + +You can also create a `.env` file with `SLACK_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. ``` -bundle install -bundle exec rake +git checkout master +git pull upstream master +git checkout -b my-feature-branch ``` ## Write Tests diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md index 5655602..26ba927 100644 --- a/DEPLOYMENT.md +++ b/DEPLOYMENT.md @@ -22,7 +22,7 @@ heroku config:add SLACK_API_TOKEN=... #### GIPHY_API_KEY -Slack-Gamebot replies with animated GIFs. While it's currently not necessary, uyou may need to set GIPHY_API_KEY in the future, see [github.com/Giphy/GiphyAPI](https://github.com/Giphy/GiphyAPI) for details. +Slack-Gamebot replies with animated GIFs. While it's currently not necessary, you may need to set GIPHY_API_KEY in the future, see [github.com/Giphy/GiphyAPI](https://github.com/Giphy/GiphyAPI) for details. ### Heroku Idling diff --git a/README.md b/README.md index 5a14816..838fb50 100644 --- a/README.md +++ b/README.md @@ -9,18 +9,6 @@ A math bot for Slack. ## Installation -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= foreman start` - -While it's currently not necessary, uyou may need to set _GIPHY_API_KEY_ in the future, see [github.com/Giphy/GiphyAPI](https://github.com/Giphy/GiphyAPI) for details. - -## Production Deployment - See [DEPLOYMENT](DEPLOYMENT.md). ## Usage