GitHub App Usage

How does it work?

When first installed the app will scan all repos it is given permissions for. If it finds Python files that can be refactored in the default branch, it will create a pull request per repo with these improvements. This pull request can then be reviewed and merged in the normal way.

From then on Sourcery will scan every new pull request. If it finds suggestions in the changed files, it will create a new PR branched off the new PR branch. This PR can then be reviewed and merged into your PR.

Quality Report

Sourcery will comment on each pull request scanned with a Quality Report. This details whether the pull request has increased or decreased code quality in the affected files, and gives a breakdown per file. It also shows up to five functions in these files that have a low quality score, and our recommendations for improving them. Please see the Quality Report page for more details on the metrics used and how we calculate the quality score.

Configuration

See Sourcery configuration for details on the .sourcery.yaml configuration file.