Software-Improvement-Group / sigridci

Sigrid CI: Measure and improve your code, continuously
https://docs.sigrid-says.com
38 stars 38 forks source link

Document rate limiting threshold #516

Closed tukraus closed 2 weeks ago

github-actions[bot] commented 3 weeks ago

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-10-17.

👍 What went well?

You fixed or improved 0 refactoring candidates.

👎 What could be better?

Unfortunately, 5 refactoring candidates were introduced or got worse.

Risk System property Location
🟠 Unit Interfacing
(Introduced)
src/sigrid_api_client.py
SigridApiClient.retry(operation,attempts,allow404,allowEmpty,server)
🟡 Unit Size
(Introduced)
src/azure_pull_request_report.py
AzurePullRequestReport.generate(analysisId,feedback,options)
🟡 Unit Complexity
(Introduced)
src/sigrid_api_client.py
SigridApiClient.retry(operation,attempts,allow404,allowEmpty,server)
🟡 Unit Interfacing
(Introduced)
src/azure_pull_request_report.py
AzurePullRequestReport.callAzure(method,body,threadId)
🟡 Unit Interfacing
(Worsened)
src/azure_pull_request_report.py
AzurePullRequestReport.generate(analysisId,feedback,options)

📚 Remaining technical debt

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

Risk System property Location
🟡 Unit Size
(Unchanged)
src/sigrid_api_client.py
SigridApiClient.callSigridAPI(path,body,contentType)
🟡 Unit Complexity
(Unchanged)
src/sigrid_api_client.py
SigridApiClient.obtainUploadLocation(systemExists)
🟡 Unit Interfacing
(Unchanged)
src/sigrid_api_client.py
SigridApiClient.callSigridAPI(path,body,contentType)

Sigrid ratings

System property System on 2024-10-17 Before changes New/changed code
Volume 5.5 N/A N/A
Duplication 5.5 5.5 5.5
Unit Size 4.3 4.4 4.7
Unit Complexity 3.8 2.4 3.7
Unit Interfacing 2.1 1.5 1.9
Module Coupling 3.1 5.5 5.5
Component Independence N/A N/A N/A
Component Entanglement N/A N/A N/A
Maintainability 4.0 4.0 4.5

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.