craigsheen / olfaction

Automatically detect code smells in your pull requests

Olfaction

Automatically detect code smells in your pull requests.

How to

1. Fork this repo.

2. Deploy to wherever you want.

3. Get a GitHub access_token.

4. Set your GitHub access_token to ENV['access_token'].

5. Set a webhook on which ever repo(s) you want to detect code smells on. You will need to select Let me select individual events. and then Pull Request from the options. Set the Payload URL to be <MY_URL>/pull_requests.

6. When a new pull request is created, GitHub will send the details to your forked application, the application will then run reek on the changed files and comment directly on your pull request with any code smells. See example here

Thanks

Obviously this heavily relies on reek

TODO

• Improve the PR list style and add more information like the timestamp and smells.
• Integrate more than reek? (rubocop seems like a sensible next step)