Configuration

Sourcery Code Reviews are configurable to allow you to tailor the components of our code reviews that we show, the language of the reviews, and to allow you to tailor your reviews more specifically to your codebase and your needs.

Basic Configuration¶

Sourcery's basic configuration is controlled through the Review Settings section of your Sourcery dashboard.

Basic Configuration

Lanugage Configuration You can set up Sourcery to deliver your code reviews in whatever language you prefer. Select your language from the dropdown menu and new reviews will be generated in that language.

Review Sections You can enable or disable the PR Summary, Review Guide, and Approvals on PRs by toggling the buttons next to each section. The PR Summary and Review Guide are enabled by default while PR Approvals is disabled by default.

Review Instructions¶

Sourcery's reviews can be tailored to focus on topics and feedback that are more relevant to your team. You can add in speific review instructions to tell Sourcery to look for specific issues or to not focus on certain things.

Review Instructions

Specifying an Instruction Path Pattern¶

Review instructions can be tailored to only be triggered on certain areas of your project or specific file types. For any instruction you need to define a file path glob pattern for that rule to apply to.

For example for an instruction to apply to all JS files in src and all TypeScript files the pattern would be: src/**/*.js,**/*.ts

Best Practices for Review Instructions¶

Review instructions work the best when they are specific and structured as short, concise sentences or bullet points. While you can add multiple instructions within a single input block we recommend that you keep your instructions to fewer than 3 per block.

Coding Assistant Configuration¶

For details on configuring the Sourcery Coding Assistant, please see the Coding Assistant Configuration section of our docs.