Conversation
Reviewer's Guide by SourceryThis pull request introduces code complexity analysis using xenon. It sets up a new GitHub Actions workflow to run xenon with specified complexity thresholds and adds a Makefile target for local execution. State diagram for code complexity levelsstateDiagram-v2
[*] --> ComplexityAnalysis
state ComplexityAnalysis {
state "Level A (1-10)" as A
state "Level B (11-20)" as B
state "Level C (21-30)" as C
state "Level D (31-40)" as D
state "Level E (41+)" as E
A --> B : Increasing Complexity
B --> C : Increasing Complexity
C --> D : Increasing Complexity
D --> E : Increasing Complexity
note right of A : Ideal
note right of B : Acceptable
note right of C : Needs Refactoring
note right of D : Immediate Attention
note right of E : Critical
}
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @JaeAeich - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
uniqueg
reviewed
Jan 6, 2025
{{ cookiecutter.project_name_dashed }}/.github/workflows/code_quality.yaml
Outdated
Show resolved
Hide resolved
uniqueg
approved these changes
Jan 8, 2025
Member
uniqueg
left a comment
There was a problem hiding this comment.
Fine, but please update the PR description before you merge.
Collaborator
Author
|
@sourcery-ai summary |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Use ruff and mccabe to check code complexity.
Checklist
project, including, in particular, with regard to any style guidelines
specification; in particular, it clearly indicates
that a change is a breaking change
using the PR title as the commit message
changed behavior
or updated existing ones (only for Python, TypeScript, etc.)
docstrings) for all packages/modules/functions/classes/
methods or updated existing ones
works
Comments
Lets just move on before we find another noble gas named pypi package :).
Summary by Sourcery
Add code complexity analysis using xenon.
CI:
Tests:
Summary by Sourcery
Build: