Development

Requirements

Running Charlesbot locally

Clone the Charlesbot source code locally:

git clone https://github.com/marvinpinto/charlesbot.git

Inside the charlesbot source tree, create a development.yaml file that looks something like:

main:
  slackbot_token: 'xoxb-...'
  enabled_plugins:

Note that you will need a valid Slack Bot Token, if you don’t already have one.

Install Charlesbot in a virtualenv:

make install

Run Charlesbot in debug mode:

make run

Contributing

  1. Fork the Charlesbot repository on GitHub
  2. Write some cool stuff! (fix some bugs, add new features, update documentation, etc)
  3. Write some (relevant) tests!
  4. Submit a Pull Request

Running tests locally

Check for style violations:

make checkstyle

Run the unit tests locally:

make test