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.

Configuration

Sourcery GitHub app cannot currently be configured but this will be coming soon.

Disabling Sourcery

There are 2 ways to disable Sourcery on a repo:

1. Configure the GitHub app with a specific repository list
2. Uninstall Sourcery from your user or organization entirely

Both of these options can be performed by going to

• Settings > Applications - for a user account
• Organization Settings > Installed GitHub Apps - for an organization.