How to Use Sourcery

Getting started with Sourcery

In this guide, you'll learn how to set up Sourcery to enhance your code review process and automate refactoring, making your code cleaner and more efficient.

Step 1: Sign up and set up

1. Go to sourcery.ai.
2. Click on the Sign Up button in the top right corner.
3. Enter your email address and create a password, or sign up using your GitHub or GitLab account for easier integration.
4. Once signed up, you'll be prompted to connect your GitHub or GitLab account. Follow the instructions to authorise access.

Step 2: Your first code review

1. After connecting your account, navigate to the Dashboard.
2. Select a repository from your connected GitHub or GitLab projects.
3. Click on the Scan button to analyse your code. Sourcery will review your code and provide suggestions for improvements.
4. Review the suggestions presented. You can click on each suggestion to see more details.
5. To apply a suggestion, simply click the Apply button next to it. This will automatically refactor your code based on the AI's recommendations.

Step 3: Get better results

1. Explore the Settings menu by clicking on your profile icon in the top right corner.
2. Under Preferences, you can select your preferred programming languages and adjust the level of suggestions (e.g., strict or relaxed).
3. Regularly check the Insights tab to understand common issues in your codebase and track improvements over time.
4. Use the Pull Requests feature to get automated reviews on your code changes before merging.

Pro tip

Set up Sourcery as a GitHub App or GitLab Integration to automatically review pull requests and provide live feedback to your team without needing to manually trigger scans.

Common mistake to avoid

Avoid skipping the setup of preferred languages and settings; not customising these options can lead to irrelevant suggestions that don't fit your coding style or project needs.