Teaching Sourcery

Sourcery is designed to adapt its code reviews to your preferences and team's style and best practices.

Providing Feedback to Sourcery

Sourcery includes a thumbs up and thumbs down emoji on every code review comment as a way for you to easily be able to provide feedback on the comment.

If you like the comment and found it useful, add a thumbs up. If you disliked the comment, found it didn't apply, was incorrect, or just don't want to see comments like that, add a thumbs down.

Sourcery will take this information to help tailor its reviews for you. When it generates future reviews it will look to create comments that are more similar to ones you've added thumbs ups to in the past and filter out comments similar to those that you've added thumbs downs to.

Telling Sourcery Your Coding Conventions

You can tailor what Sourcery looks for in a code review by defining your own Review Rules.

These rules tell Sourcery what things it should and shouldn't look for in specific areas of your code base when conducting a code review. If you have existing coding standards/style guides/contributing guidelines we recommend adding those in as Review Rules to make Sourcery's reviews as relevant as possible.

For set up details, please see the Review Rules section of our docs.