Quality Measurements - benjaminsunliu/ConUMap GitHub Wiki

Quality Measurement Metrics

Birds Eye View

This is an overview of all the quality metrics for the app, updated after each sprint.

Official Documentation Size

alt text

Size & Duplication on new code

alt text

Internal Documentation Size

alt text

Code convention violations

alt text

Security Vulnerabilities

alt text

Project Complexity

alt text

Sprint 1 & 2

  1. Core Metrics (From SonarQube)
  • Size: 22 493
  • Duplication: 0.0%
    • Only duplicated code comes from theme.ts for light mode vs dark mode colours. It has been deemed acceptable.
  • Documentation: 1.5%
    • We might need more comments...
  • Complexity:
    • Cyclomatic Complexity: 158
    • Cognitive Complexity: 64
  • Technical Debt:
    • Estimated effort to fix
      • Reliability Issues: 15 min
      • Maintainability Issues: 1h15
      • Total: 1h30
  • Security Vulnerabilities:
    • 0 security hotspots (3 deemed safe)
  • Code Convention Violations:
    • 12 code smells
  1. Addressed Issues (Commits & PRs)
  1. Evolution Data (For Wiki Charting)

Sprint 3

No new issues were merged into master and no issues in master were fixed either so the statistics are the same as above. Specific issues were addressed during PR reviews and never made it to master.

Improvement Effort Reference
Fix technical debt of catastrophic backtracking vulnerability COMMIT
Remove dead code COMMIT
Update package depedancies to keep vulnerabilities up to date COMMIT
Address cognitive complexity in ternary operator COMMIT
Remove mutability of objects code dept COMMIT

Sprint 4

  • Size: 8062 new lines
  • Duplication: 0.0%
  • Documentation: 3.6%
  • Complexity:

    Cyclomatic: 503 Cognitive: 268

  • Technical Debt:

    Reliability Issues: 0 min Maintainability Issues: 5 min

  • Security Hotspots: 0
  • 1 Code Smells

Release 2

During this release, we have adopted a more proactive approach to addressing Sonar Issues. For all PR's, we solved and address all issues before merging. This resulted in no new issues being merged into our master branch. We have also done a PR dedicacted to solving all issues from Release 1.

In future releases, we plan on keeping this approach to avoid accumulating issues and to keep our repo clean, safe and maintainable.

Sprint 5

alt text

  • Size: 9,380 lines
  • Duplication: 0.0%
  • Documentation: 4.2%
  • Complexity:

    Cyclomatic: 624 Cognitive: 342

  • Technical Debt:

    Reliability Issues: 0 min Maintainability Issues: 8 min

  • Security Hotspots: 0
  • 2 Code Smells

Sprint 6

Size: 24082 new lines

Duplication: 0.6%

Documentation: 2.8%

Complexity: Cyclomatic: 1346 Cognitive: 741

Technical Debt:

  • Reliability Issues: 0 min
  • Maintainability Issues: 0 min

Security Hotspots: 0

0 Code Smells

Release 3

During this release, we have kept the same proactive approach to addressing Sonar Issues. For all PR's, we solved and address all issues before merging. This resulted in no new issues being merged into our master branch.

As a result we end the release with no issues. This approach helped us avoid accumulating issues and to keep our repo clean, safe and maintainable.