Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feedback: Add column to table that shows the maintainability of the code before the changes. #495

Merged
merged 3 commits into from
Sep 4, 2024

Conversation

dennis-sig
Copy link
Contributor

No description provided.

Copy link

github-actions bot commented Sep 4, 2024

Sigrid maintainability feedback

✅ You wrote maintainable code and achieved your Sigrid objective of 3.0 stars

Sigrid compared your code against the baseline of 2024-08-30.

👍 What went well?

You fixed or improved 1 refactoring candidates.

Risk System property Location
🟠 Module Coupling
(Improved)
src/report.py

👎 What could be better?

You did not introduce any technical debt during your changes, great job!

📚 Remaining technical debt

4 refactoring candidates didn't get better or worse, but are still present in the code you touched.

Risk System property Location
🟡 Unit Interfacing
(Unchanged)
src/report.py
Report.formatRating(ratings,metric,naText)
🟡 Unit Interfacing
(Unchanged)
src/report.py
Report.generate(analysisId,feedback,options)
🟡 Unit Interfacing
(Unchanged)
src/pipeline_summary_report.py
PipelineSummaryReport.printConclusionMessage(feedback,options,status)
🟡 Unit Interfacing
(Unchanged)
src/pipeline_summary_report.py
PipelineSummaryReport.generate(analysisId,feedback,options)

Sigrid ratings

System property System on 2024-08-30 Before changes New/changed code
Volume 5.5 N/A N/A
Duplication 5.5 5.5 5.5
Unit Size 4.3 5.5 5.5
Unit Complexity 3.8 5.5 5.5
Unit Interfacing 2.1 2.0 1.9
Module Coupling 3.1 0.5 0.5
Component Independence N/A N/A N/A
Component Entanglement N/A N/A N/A
Maintainability 4.0 3.8 3.8

View this system in Sigrid


Did you find this feedback helpful?

We would like to know your thoughts to make Sigrid better.
Your username will remain confidential throughout the process.

@dennis-sig
Copy link
Contributor Author

dennis-sig commented Sep 4, 2024

@patveck The funny thing is that you can use this merge request to see the change: It's the 3rd column in the "Sigrid ratings" table. The end point already has this information, we just didn't show it. This is more similar to the New/Changed Code Quality page in Sigrid, and we had some people asking if we can also add it to the CI output.

@dennis-sig dennis-sig merged commit 151bc15 into main Sep 4, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants