Files
devops-skills/skills/gitea-issue-devops-agent/references/issue-template-standard.md
seekee421 ccfdda4342
Some checks failed
publish-site / deploy-public-site (push) Has been cancelled
docs: make devops skill plan-first and jj-aware
2026-03-13 13:18:48 +08:00

2.2 KiB

Issue Template Standard

Use these templates to create AI-ready issues. The goal is to give both humans and agents enough context to produce a reviewable first PR instead of an ambiguous code dump.

Global Rules

  • Every issue should map to one reviewable outcome.
  • Prefer explicit issue selection to start delivery:
    • issue comment mention or webhook trigger
    • app/UI selection
    • CLI selection
  • Queue scans may suggest issues, but should not start coding until one issue is explicitly selected.
  • Always include acceptance criteria and affected area hints.
  • If screenshots, recordings, or logs exist, attach them in the issue instead of describing them vaguely.

Common Required Fields

  • summary
  • issue type: bug, enhancement, or feature
  • current behavior
  • expected behavior
  • affected user or business impact
  • related pages/modules/interfaces
  • acceptance criteria
  • attachments or logs

Bug Template

[bug-template-v1]
Summary:

Environment:
- app version:
- browser/device/os:
- time window:

Current behavior:

Expected behavior:

Reproduction steps:
1.
2.
3.

Affected area:
- pages/routes:
- services/apis:
- files or modules if known:

Impact:

Evidence:
- screenshot/video/log links:

Acceptance criteria:
- [ ]
- [ ]

Non-goals:

Enhancement Template

[enhancement-template-v1]
Summary:

Background:

Current limitation:

Desired improvement:

Affected area:
- pages/routes:
- services/apis:
- files or modules if known:

User value:

Constraints:
- compatibility:
- performance:
- rollout/risk:

Acceptance criteria:
- [ ]
- [ ]

Evidence or references:

Feature Template

[feature-template-v1]
Summary:

Business goal:

User story:
As a <role>, I want <capability>, so that <outcome>.

Scope:
- in scope:
- out of scope:

Expected behavior:

Affected area:
- pages/routes:
- services/apis:
- files or modules if known:

Dependencies or prerequisites:

Acceptance criteria:
- [ ]
- [ ]
- [ ]

Validation path:
- happy path:
- edge cases:

Evidence, mockups, or references:

Selection Trigger Examples

@funmd-bot take issue #123
CLI: devops-agent run --issue 123 --mode semi-automatic
UI: Select issue #123 -> Generate plan -> Create branch and draft PR