Preparing for Development
Set up
- Clone the git repository
- Copy
.env.example
to.env
and update the variables there.- The
SLACK_API_TOKEN
specifies which Slack bot Zayo will access Slack as. - If you want to use the google calendar integration, create an API Key here: https://console.developers.google.com/apis/dashboard
- Ask someone for access to the Wit.ai dev project, or create a new one
- The
- Start the bot using
docker-compose up -d --build
- If you've created a new Wit.ai project, run
docker-compose exec zayo bin/update-wit
to "teach" Wit.ai. This is asynchronous to the command and may take some time. You can watch that on Wit.ai's dashboard. - Go to Slack and say hi to the bot.
During development
If changing core functionality, add unit tests for that. See spec/skill_spec.rb
for a lot of examples.
Tests can be run using bin/test
(not currently docker-aware).
Before you make a PR
- Make sure the tests pass
- Run and test manually the interactions you have changed