chore(github): add an issue form for technical improvements (#7974) - #7975
Laurent Giovannoni (laugiov) wants to merge 1 commit into
Conversation
|
Thank you for your contribution. This PR is but one step away from being ready for merging: all commits must be PGP-signed. To get started, please see https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits |
|
📖 Documentation check — ✅ Passed No functional source changes detected. |
2 similar comments
|
📖 Documentation check — ✅ Passed No functional source changes detected. |
|
📖 Documentation check — ✅ Passed No functional source changes detected. |
There was a problem hiding this comment.
Pull request overview
Adds a standardized GitHub issue form and completed example for technical improvements.
Changes:
- Adds structured required and optional improvement fields.
- Adds a simulation-engine refactoring example.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Review summary |
|---|---|
.github/TECHNICAL_IMPROVEMENT_EXAMPLE.md |
Completed example submission; label list should include technical improvement. |
.github/ISSUE_TEMPLATE/4-technical_improvement.yml |
Defines the issue form; has a blocking label-taxonomy conflict and a stale NOTES.md reference. |
Suppressed comments (1)
.github/ISSUE_TEMPLATE/4-technical_improvement.yml:4
- issue (blocking): This form creates a Task with only
technical improvementandneeds triage, but.github/LABELS.md:124-126requires every issue to have exactly one primary type label (feature,bug, ordocumentation) matching its title and GitHub Type. Issues created here will therefore violate the repository's issue taxonomy; either maketechnical improvementan explicitly documented exception or update the form and label guidance together.
labels: ["needs triage", "technical improvement"]
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| # Deliberately not required. GitHub can force a non-empty box, it cannot force a real | ||
| # answer, and a forced box is how "technical debt" ends up in this field. Section 6 of the | ||
| # Notion page has the triage agent check effort, cost avoided and impact — not this field. | ||
| # See NOTES.md. |
| refactor(execution): split simulation execution from the shared scheduler | ||
| ``` | ||
|
|
||
| **Labels:** `needs triage` · **Type:** Task |
Adds the issue form used to declare a technical improvement, and one filled example on the simulation engine refactoring. Refs #7974
aab4916 to
cebc116
Compare
| A rough size, not a number of days. Pick the closest one. "Not sized yet" is honest, | ||
| but expect the topic to come back for sizing before it can be planned. | ||
| options: | ||
| - a few days |
There was a problem hiding this comment.
we dropped T-shirt size?
What
Adds the GitHub issue form used to declare a technical improvement, and one filled example.
.github/ISSUE_TEMPLATE/4-technical_improvement.yml— eight fields, four of them required: what we propose, effort estimate, cost avoided (exactly the three values from the Technical improvements page: risk of incident, slower delivery, support load), impact if we do nothing. Optional: evidence, area, staff driven or vertical, and a confirmation that the topic is not a security finding. The form appliesneeds triageandtechnical improvement, and sets the issue type toTask..github/TECHNICAL_IMPROVEMENT_EXAMPLE.md— the form filled on the simulation engine refactoring, the hardest case we have: real customer impact, a performance risk, and no load data to back it today.Why
A technical ticket loses against a feature when nobody can compare the two. These fields make them comparable, and the list is short on purpose. The issues are also read by a triage agent that looks for duplicates, flags missing fields and groups by area, so the form uses dropdowns with normalised values rather than free text wherever it can.
Notes for the reviewer
ISSUE_TEMPLATE/on purpose: any.mdin that folder is treated as a legacy issue template and would show up in the "New issue" chooser.slower deliveryfor now.main.Closes #7974