General Introduction
Sourcery is an artificial intelligence-based code review tool designed to help developers automate code quality improvements and increase development productivity. Integrated into GitHub and GitLab repositories, it instantly reviews every pull request, providing human-like feedback on code reviews.Sourcery focuses on discovering bugs and security risks in code, simplifying complex code, and helping development teams reduce technical debt. With Sourcery, developers can focus more on building new features and less on dealing with legacy code issues.
Function List
- Instant code review: Provide immediate code review feedback on every pull request.
- Error and security risk detection: Automatically detects errors and potential security risks in your code.
- Code Complexity Management: Flagging and fixing complex code to ensure it is well designed.
- Multi-platform support: Supports integration with GitHub and GitLab repositories.
- code refactoring: Automatically refactor Python code to improve code quality and maintainability.
- Teamwork: Facilitate code review and collaboration among team members.
Using Help
Installation and Integration
- Registration and Login: Visit the Sourcery website (https://sourcery.ai/), register for an account and log in.
- Connecting to Code Repositories: In the Sourcery dashboard, select Connect to a Repository and then select GitHub or GitLab to authorize the connection.
- Configuration items: Select the project you want to integrate with and Sourcery will automatically start reviewing the code in that project.
Code Review with Sourcery
- Creating a pull request: Create a new pull request in GitHub or GitLab.
- View review feedback: Sourcery automatically reviews the code in a pull request and provides feedback within seconds. Feedback includes general suggestions, in-line comments, and related suggestions.
- Handling of feedback: Based on the feedback provided by Sourcery, the code is modified and updates are submitted, and Sourcery reviews the updated code again to ensure that all issues have been resolved.
Code refactoring and optimization
- automatic reconfiguration: Sourcery automatically identifies and refactors inefficient parts of your code to improve its quality.
- manual adjustment: Developers can manually tweak their code based on Sourcery's recommendations to ensure that it conforms to best practices.
Managing technical debt
- Technical debt report: Sourcery provides detailed technical debt reports to help teams identify and manage technical debt in their code.
- continual improvement: By using Sourcery on a regular basis, teams can continuously improve code quality and reduce the accumulation of technical debt.