Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: "🐛 Bug Report"
description: Report something that is currently broken or failing in production.
title: "[Bug] "
labels: ["type:bug"]
body:
- type: textarea
id: current-behavior
attributes:
label: "🚨 Current Behavior"
description: Clear description of what is failing right now.
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: "🎯 Expected Behavior"
description: What should be happening instead?
validations:
required: true

- type: textarea
id: impact-if-fixed
attributes:
label: "💥 End-User Impact — if the bug is fixed"
description: What is the impact on the current customer if the bug is fixed?
placeholder: |
e.g., Blocked from completing checkout, visual styling issue only, data loss risk, minor workaround required
validations:
required: true

- type: textarea
id: impact-if-not-fixed
attributes:
label: "💥 End-User Impact — if the bug is NOT fixed"
description: What is the impact on the current customer if the bug is NOT fixed?
placeholder: |
e.g., Customer remains completely blocked from completing checkout, continuous risk of missing compliance audit windows, minor manual workaround remains required daily
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: "👣 Steps to Reproduce"
description: Steps to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error message: [Paste error log or screenshot here]
validations:
required: true

- type: input
id: release-version
attributes:
label: "💻 Release Version"
description: Release version, or commit date if on main
placeholder: "[or commit date if in main]"
validations:
required: true

- type: textarea
id: verification-plan
attributes:
label: "🧪 Verification & Validation Plan"
description: How was this validated?
placeholder: |
e.g., Checked staging logs, verified with solid testing evidence, reproduced locally with automated test suite
validations:
required: true

- type: checkboxes
id: verification-checklist
attributes:
label: "🧪 Verification Checklist"
options:
- label: Bug patch verified successfully in target environment.
- label: Regression testing completed to ensure nearby features are unaffected.
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: "📚 Epic"
description: A parent issue that groups a set of user stories toward one outcome.
title: "[Epic] "
labels: ["type:epic"]
body:
- type: markdown
attributes:
value: |
An epic is a **set of stories**, not a story itself. Size and sprint
the child stories. Leave this issue unpointed and off the sprint.
After filing, add those stories as GitHub sub-issues of this epic.

- type: textarea
id: outcome
attributes:
label: "🎯 Outcome"
description: What will be true when this epic is complete?
placeholder: One or two sentences describing the user or business outcome.
validations:
required: true

- type: textarea
id: why
attributes:
label: "💡 Why this epic"
description: Why this work, and why now?
validations:
required: true

- type: textarea
id: stories
attributes:
label: "📖 Stories"
description: List the user stories in this epic. After this issue is created, add each as a GitHub sub-issue. Do not size this epic.
placeholder: |
- [ ] [Story] ...
- [ ] [Story] ...
- [ ] [Story] ...
validations:
required: true

- type: textarea
id: out-of-scope
attributes:
label: "🚫 Out of Scope"
description: What is explicitly not included in this epic?
placeholder: |
- [ ] Item 1
- [ ] Item 2
validations:
required: false

- type: checkboxes
id: definition-of-done
attributes:
label: "🏁 Definition of Done"
options:
- label: Child stories are filed as GitHub sub-issues of this epic.
- label: This epic is not sized; Size lives on the child stories.
- label: This epic is not assigned to a sprint; stories are.
- label: All child stories are complete and the outcome above is met.
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: "🚀 Feature"
description: Propose a new feature, optimization, or improvement
title: "[Feature] "
labels: ["type:enhancement"]
body:
- type: textarea
id: problem-description
attributes:
label: "📝 Problem Description"
description: A clear and concise description of what the problem or limitation is.
validations:
required: true

- type: textarea
id: proposed-solution
attributes:
label: "💡 Proposed Solution"
description: A clear description of what you want to happen and how this feature should look or function.
validations:
required: true

- type: textarea
id: benefit-if-done
attributes:
label: "💎 Current customer & Community Benefit — if we do this"
description: Who benefits from this and why?
placeholder: |
e.g., Saves developers 20 minutes per day, reduces API load for self-hosted community instances, cleans up UI noise for end-users
validations:
required: true

- type: textarea
id: impact-if-not-done
attributes:
label: "💎 Current customer & Community Benefit — if we DO NOT do this"
description: What happens to our current stakeholders if we DO NOT do this?
placeholder: |
e.g., The team will continue to accumulate manual maintenance debt, API costs will scale linearly with traffic, the user experience remains fragmented and hard to adopt for external community members
validations:
required: true

- type: textarea
id: validation-plan
attributes:
label: "🧪 Technical Validation & Verification Plan"
description: How should this feature be validated once built?
placeholder: |
e.g., Provide a script to verify structural data output, benchmark database performance, manually check responsive scaling
validations:
required: true

- type: checkboxes
id: validation-checklist
attributes:
label: "🧪 Verification Checklist"
options:
- label: Automated testing evidence provided (Unit or Integration tests).
- label: Feature verified successfully in a target staging environment.

- type: checkboxes
id: definition-of-done-quality
attributes:
label: "🏁 Definition of Done — 🛠️ Quality & Testing"
options:
- label: Code has been peer-reviewed for bugs and vulnerabilities.
- label: Proper testing has been completed and passed (Unit, Integration, E2E via GitHub Actions).
- label: The feature has been demonstrated/validated successfully in the target environment.

- type: checkboxes
id: definition-of-done-docs
attributes:
label: "🏁 Definition of Done — 📝 Architecture & Docs"
options:
- label: Usage documentation or changelog updated (if user-facing changes introduced).
- label: Local ADR written and verified by Architecture & Alignment Committee if technical architecture deviated.
- label: Any newly introduced technical debt has been logged as a GitHub Intake.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/spike.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: "🔬 Spike"
description: Time-boxed investigation to explore a technical approach or clear up uncertainty.
title: "[Spike] "
labels: ["type:spike"]
body:
- type: textarea
id: core-question
attributes:
label: "❓ The Core Question"
description: What specific technical unknown are we trying to answer with this exploration?
placeholder: |
Example: Can our architecture handle 500 simultaneous requests on mobile viewports?
validations:
required: true

- type: input
id: time-allocated
attributes:
label: "⏱️ Time Allocated"
description: Time-box for this spike
placeholder: "e.g., 4 Hours / Max 1 Day"
validations:
required: true

- type: checkboxes
id: required-deliverables
attributes:
label: "🏁 Required Deliverables"
options:
- label: Written summary of findings added as a comment below or linked markdown file.
- label: Proof of Concept (PoC) code shared when applicable (branch, fork, or local investigation notes).
- label: Clear "Go / No-Go" technical recommendation for the Architect.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: "⚙️ Task"
description: A technical delivery task that does not directly introduce a new user-facing feature.
title: "[Task] "
labels: ["type:task"]
body:
- type: textarea
id: description
attributes:
label: "📝 Description"
description: Provide a clear, technical overview of what needs to be changed in the codebase.
validations:
required: true

- type: textarea
id: technical-checklist
attributes:
label: "🛠️ Technical Checklist"
description: Steps to complete this task.
placeholder: |
- [ ] Step 1 (e.g., Run database migration scripts)
- [ ] Step 2 (e.g., Update configuration variables in environment files)
- [ ] Step 3
validations:
required: true

- type: checkboxes
id: verification-plan
attributes:
label: "🧪 Verification Plan"
options:
- label: Peer review completed.
- label: All CI/CD checks pass successfully in GitHub Actions.
74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/user_story.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: "📖 User Story"
description: Describe a feature or user outcome from the user's perspective.
title: "[Story] "
labels: ["type:story"]
body:
- type: markdown
attributes:
value: |
### 👤 User Story
- type: input
id: as-a
attributes:
label: "As a"
description: Type of user
placeholder: "[type of user]"
validations:
required: true
- type: input
id: i-want
attributes:
label: "I want to"
description: Perform an action / have a capability
placeholder: "[perform an action / have a capability]"
validations:
required: true
- type: input
id: so-that
attributes:
label: "So that"
description: The business value or benefit received
placeholder: "[the business value or benefit received]"
validations:
required: true

- type: textarea
id: acceptance-criteria
attributes:
label: "🎯 Acceptance Criteria"
description: What must happen for this feature to be considered structurally functional?
placeholder: |
- [ ] Criteria 1 (e.g., Clicking 'Export' generates a CSV file download)
- [ ] Criteria 2
- [ ] Criteria 3
validations:
required: true

- type: textarea
id: out-of-scope
attributes:
label: "🚫 Out of Scope"
description: What is explicitly not included in this story?
placeholder: |
- [ ] Item 1
- [ ] Item 2
validations:
required: false

- type: checkboxes
id: definition-of-done-quality
attributes:
label: "🏁 Definition of Done — 🛠️ Quality & Testing"
options:
- label: Code has been peer-reviewed for bugs and vulnerabilities.
- label: Proper testing has been completed and passes (Unit, Integration, E2E via GitHub Actions).
- label: The feature has been demonstrated/validated successfully in the target environment.

- type: checkboxes
id: definition-of-done-docs
attributes:
label: "🏁 Definition of Done — 📝 Architecture & Docs"
options:
- label: Usage documentation or changelog updated (if user-facing changes introduced).
- label: Local ADR written and verified by Tech Lead if technical architecture deviated.
- label: Any newly introduced technical debt has been logged as a GitHub issue.
1 change: 1 addition & 0 deletions .github/workflows/ci_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ jobs:
permissions:
contents: read
issues: read
pull-requests: read
Loading