Skip to content

chore(github): add an issue form for technical improvements (#7974) - #7975

Open
Laurent Giovannoni (laugiov) wants to merge 1 commit into
mainfrom
lgi/7974-technical-improvement-issue-form
Open

Laurent Giovannoni (laugiov) wants to merge 1 commit into
mainfrom
lgi/7974-technical-improvement-issue-form

Conversation

@laugiov

@laugiov Laurent Giovannoni (laugiov) commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

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 applies needs triage and technical improvement, and sets the issue type to Task.
  • .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

  • The example lives outside ISSUE_TEMPLATE/ on purpose: any .md in that folder is treated as a legacy issue template and would show up in the "New issue" chooser.
  • Evidence is not marked required. Five required fields would be one too many, and GitHub can only force a non-empty box, which is how "technical debt" ends up in that field. Section 6 of the Technical improvements page has the triage agent check effort, cost avoided and impact, not evidence.
  • Still open, and not blocking this pull request: section 1 of the page says a technical improvement "gives the product a capability or lowers one of three costs", while Cost avoided only carries the three costs. Work that exists to unlock a later capability has to be filed as slower delivery for now.
  • The form only becomes selectable once this is on main.

Closes #7974

Copilot AI lite review requested due to automatic review settings September 15, 2026 07:42
@laugiov Laurent Giovannoni (laugiov) added filigran team Item from the Filigran team. vibe-coded PR: AI-assisted change — the author reviews it before requesting others' review. labels Sep 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown
Contributor

📖 Documentation check — ✅ Passed

No functional source changes detected.

2 similar comments
@github-actions

Copy link
Copy Markdown
Contributor

📖 Documentation check — ✅ Passed

No functional source changes detected.

@github-actions

Copy link
Copy Markdown
Contributor

📖 Documentation check — ✅ Passed

No functional source changes detected.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 improvement and needs triage, but .github/LABELS.md:124-126 requires every issue to have exactly one primary type label (feature, bug, or documentation) matching its title and GitHub Type. Issues created here will therefore violate the repository's issue taxonomy; either make technical improvement an 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
@laugiov
Laurent Giovannoni (laugiov) force-pushed the lgi/7974-technical-improvement-issue-form branch from aab4916 to cebc116 Compare September 15, 2026 08:02
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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we dropped T-shirt size?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

filigran team Item from the Filigran team. vibe-coded PR: AI-assisted change — the author reviews it before requesting others' review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore(github): add an issue form for technical improvements

3 participants