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

Configure Sigrid #857

Merged
merged 4 commits into from
Jan 14, 2025
Merged

Configure Sigrid #857

merged 4 commits into from
Jan 14, 2025

Conversation

praseodym
Copy link
Contributor

@praseodym praseodym commented Jan 14, 2025

Configure GitHub Actions workflows for Sigrid: the main branch is published as the latest version of the code, and for pull requests the branch is analyzed and a comment will be added to the PR with the Sigrid findings (example below).

Additionally, the scope file is added and updated in a separate commit so it can be diffed. The update includes new components that were written since November and configures mocks and Ladle stories as test code.

Copy link

github-actions bot commented Jan 14, 2025

Sigrid maintainability feedback

✅ You wrote maintainable code and achieved your objective of 3.5 stars

Show details

Sigrid compared your code against the baseline of 2025-01-14.

👍 What went well?

You fixed or improved 0 refactoring candidates.

👎 What could be better?

Unfortunately, 16 refactoring candidates were introduced or got worse.

Risk System property Location
🔴 Duplication
(Introduced)
frontend/app/component/election/status/ElectionStatus.module.css (lines 9-57)
frontend/app/module/election/page/ElectionStatusPage.module.css (lines 6-54)
🔴 Duplication
(Introduced)
backend/src/election/structs.rs (lines 10-19)
backend/src/election/structs.rs (lines 30-39)
🔴 Duplication
(Introduced)
backend/src/election/mod.rs (lines 221-230)
backend/src/election/mod.rs (lines 286-295)
🔴 Duplication
(Introduced)
backend/src/election/repository.rs (lines 41-49)
backend/src/election/repository.rs (lines 53-61)
🔴 Duplication
(Introduced)
backend/src/election/mod.rs (lines 221-228)
backend/src/election/mod.rs (lines 286-293)
backend/src/election/mod.rs (lines 327-334)
🔴 Duplication
(Introduced)
frontend/app/component/election/status/mockData.ts (line 522-536)
frontend/app/component/election/status/mockData.ts (line 459-473)
frontend/app/component/election/status/mockData.ts (line 396-410)
+ 16 occurrences
🔴 Unit Size
(Worsened)
backend/src/lib.rs
router(SqlitePool)
🔴 Unit Size
(Introduced)
frontend/app/component/election/status/mockData.ts
mockData.ts
⚫️ + 8 more

📚 Remaining technical debt

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

View this system in Sigrid** to explore your technical debt

⭐️ Sigrid ratings

System property System on 2025-01-14 Before changes New/changed code
Volume 5.2 N/A N/A
Duplication 4.0 4.5 2.3
Unit Size 2.4 2.1 1.6
Unit Complexity 3.2 4.3 5.0
Unit Interfacing 2.9 2.5 3.6
Module Coupling 4.1 4.4 4.6
Component Independence 2.8 N/A N/A
Component Entanglement 3.3 N/A N/A
Maintainability 3.5 3.7 3.6

💬 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.


View this system in Sigrid

Lionqueen94
Lionqueen94 previously approved these changes Jan 14, 2025
jschuurk-kr
jschuurk-kr previously approved these changes Jan 14, 2025
@praseodym
Copy link
Contributor Author

SIG Support recommended adding the convert: rust option which should exclude Rust test code from the maintainability analysis, resolving a bunch of findings in our test code. I've done that in 459fc7f.

@praseodym praseodym added this pull request to the merge queue Jan 14, 2025
Merged via the queue into main with commit 0bd46bb Jan 14, 2025
22 checks passed
@praseodym praseodym deleted the sigrid branch January 14, 2025 17:09
lkleuver pushed a commit that referenced this pull request Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants