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

More subject types #3130

Closed
Sebastiaan127001 opened this issue Dec 31, 2021 · 5 comments · Fixed by #8750 or #8829
Closed

More subject types #3130

Sebastiaan127001 opened this issue Dec 31, 2021 · 5 comments · Fixed by #8750 or #8829
Assignees
Labels
Subject(s) New, enhanced, or removed subjects
Projects

Comments

@Sebastiaan127001
Copy link
Contributor

Sebastiaan127001 commented Dec 31, 2021

When using the QT instance itself as a metric source. The issues can accumulate well above the 100 items. If QT had more detail in subject types, this could have been avoided by creating more metrics with these detailed subject types.

Suggested subject types (bold) with accompanying metrics. Subtypes have the same metrics as their supertype, plus the additional metrics listed under the subtype.

  • Process
    • Continuous integration/deployment
      • Merge requests
      • Unmerged branches
      • Pipeline duration
    • Technical debt management
      • Dependencies (for outdated dependencies)
      • Issues
      • Suppressed violations
      • Violation remediation effort
    • Defect management
      • Issues
    • Test management
      • Tests
      • Test cases
      • Manual test duration
      • Manual test execution
      • (Also include test coverage metrics?)
    • Backlog management
      • User story points (to measure ready work)
      • Velocity (to know how much work should be ready)
  • Software
    • Size
    • Security warnings
    • Ops
      • DORA metrics
    • Application
      • Scalability
      • Slow transactions
      • Test cases
    • Component
      • Commented out code
      • Complex units
      • Dependencies
      • Duplicated lines
      • Long units
      • Many parameters
      • Violations
    • Tests
      • Tests
      • Test branch coverage
      • Test line coverage
    • Documentation
      • Source up-to-dateness
      • Time remaining
  • Development environment
    • CI-tools
      • Failed CI-jobs
      • Unused CI-jobs
    • Performancetest environment
      • Performancetest duration
      • Performancetest stability
    • Development tool
      • Source version
  • Quality report
    • Missing metrics
    • Metrics

Add both the subject type and the subject subtype to the list of subjects. The subject type allows adding all metrics of the underlying subtypes.

Changes should be backwards compatible.

Tasks:

  1. Rename the CI-environment "ci" to "development_environment" in the data model and the default name to "Development environment".
  2. Write migration code to insert a new copy of each (non-deleted) report with the new subject key (if the report has one or more subjects with the key "ci").
  3. Create a separate PR for 1 and 2.
  4. Add the new subject subtypes to the data model. Subjects get an optional list of (sub)subjects, see https://pydantic-docs.helpmanual.io/usage/models/#recursive-models. In the database this should look something like this:
subjects: {
    software: {
    name: "Software",
    description: "...",
    metrics: [...],
    subjects: {
       defect_management: {
          name: "...",
       }
    }
}
  1. Add a validator to check that the list of metrics of a subject type contains all metrics of all subject subtypes (recursively).

Blocked by: #8176

@Sebastiaan127001
Copy link
Contributor Author

In addition to this, it would be useful to have a subject type for documentation, in HQ this used to be called "product quality".

@Sebastiaan127001 Sebastiaan127001 added this to Backlog in Backlog via automation Mar 22, 2022
@Sebastiaan127001 Sebastiaan127001 added the Feature New, enhanced, or removed feature label Mar 22, 2022
@Sebastiaan127001
Copy link
Contributor Author

@fniessink 1+ upvote for this feature request 😄

@Sebastiaan127001
Copy link
Contributor Author

the sub-subject types above are just an example, we should refine this better to make a more adequate list

@Sebastiaan127001
Copy link
Contributor Author

also relates to #3129

@fniessink fniessink changed the title FR more detail in subject types More subject types Mar 24, 2022
@fniessink fniessink moved this from Backlog to Refinement in progress in Backlog Jun 8, 2022
@fniessink fniessink moved this from Refinement in progress to Ready in Backlog Jul 21, 2022
@Sebastiaan127001
Copy link
Contributor Author

%VOTE

@fniessink fniessink moved this from Ready to Development in progress (max 4) in Backlog Nov 22, 2022
@fniessink fniessink moved this from Development in progress (max 4) to Ready in Backlog Nov 22, 2022
@fniessink fniessink moved this from Ready to To be refined in Backlog Dec 28, 2022
@fniessink fniessink moved this from To be refined to Refinement agenda in Backlog Jan 31, 2024
@fniessink fniessink moved this from Refinement agenda to Blocked by other issue or time in Backlog Feb 29, 2024
@fniessink fniessink moved this from Blocked by other issue or time to Ready in Backlog Apr 24, 2024
@fniessink fniessink moved this from Ready to Development in progress (max 4) in Backlog May 20, 2024
@fniessink fniessink self-assigned this May 20, 2024
@fniessink fniessink added Subject(s) New, enhanced, or removed subjects and removed Feature New, enhanced, or removed feature labels May 20, 2024
fniessink added a commit that referenced this issue May 21, 2024
Distinguish between database initialization and database migration unit tests.

Prepares for #3130.
fniessink added a commit that referenced this issue May 21, 2024
Distinguish between database initialization and database migration unit tests.

Prepares for #3130.
fniessink added a commit that referenced this issue May 21, 2024
Distinguish between database initialization and database migration unit tests.

Prepares for #3130.
fniessink added a commit that referenced this issue May 21, 2024
Split database initialization and database migration code into two modules.

Prepares for #3130.
fniessink added a commit that referenced this issue May 27, 2024
Rename the "CI-environment" subject type to "Development environment".

Prepares for #3130.
fniessink added a commit that referenced this issue May 28, 2024
Rename the "CI-environment" subject type to "Development environment".

Prepares for #3130.
fniessink added a commit that referenced this issue May 28, 2024
Rename the "CI-environment" subject type to "Development environment".

Prepares for #3130.
fniessink added a commit that referenced this issue Jun 2, 2024
fniessink added a commit that referenced this issue Jun 3, 2024
fniessink added a commit that referenced this issue Jun 3, 2024
fniessink added a commit that referenced this issue Jun 3, 2024
fniessink added a commit that referenced this issue Jun 3, 2024
fniessink added a commit that referenced this issue Jun 3, 2024
fniessink added a commit that referenced this issue Jun 3, 2024
fniessink added a commit that referenced this issue Jun 3, 2024
fniessink added a commit that referenced this issue Jun 3, 2024
fniessink added a commit that referenced this issue Jun 3, 2024
fniessink added a commit that referenced this issue Jun 3, 2024
fniessink added a commit that referenced this issue Jun 3, 2024
fniessink added a commit that referenced this issue Jun 4, 2024
fniessink added a commit that referenced this issue Jun 4, 2024
fniessink added a commit that referenced this issue Jun 6, 2024
fniessink added a commit that referenced this issue Jun 6, 2024
fniessink added a commit that referenced this issue Jun 6, 2024
fniessink added a commit that referenced this issue Jun 6, 2024
fniessink added a commit that referenced this issue Jun 7, 2024
fniessink added a commit that referenced this issue Jun 7, 2024
fniessink added a commit that referenced this issue Jun 8, 2024
fniessink added a commit that referenced this issue Jun 8, 2024
fniessink added a commit that referenced this issue Jun 8, 2024
fniessink added a commit that referenced this issue Jun 13, 2024
fniessink added a commit that referenced this issue Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Subject(s) New, enhanced, or removed subjects
Projects
Status: Release candidate released
Backlog
Development in progress (max 4)
2 participants