Sample issue template #1
Description
| Field | Purpose | Values |
|---|---|---|
| ID | Provides a stable key for linking commits, tests, release notes, and analytics; it is never reused, so history stays intact even after tickets are closed or migrated. | Project prefix + 4-digit sequence Example: POKER-0001 |
| Summary | Allows anyone scanning a backlog or email digest to instantly grasp the issue without opening the ticket. | • An imperative or noun phrase with fewer than 70 characters. • Start with a verb (“Correct…”, “Remove…”) or an object (“Null-check in…”). • Avoid stack traces or opinions. |
| Issue Type | Classifies the nature of the problem so triage and ownership are clear. | • Bug: Implementation defect • Performance: Degrades application latency or throughput by ≥ 50 ms • Integration: Fails when interacting with other services/modules • Code Quality / Maintainability: Makes code harder to read, extend, or debug • Test-Related: Affects tests or test coverage • Environment / Deployment: Arises from configuration, infrastructure, or deployment, not code |
| Build / Environment | Freezes the context in which the bug was observed, preventing “cannot reproduce” ping-pong. | JDK: 22.0.2 • OS: macOS 15.3.2, Ubuntu 22.04 • Optional fields: DB version, hardware |
| Severity | Ranks how badly production or users are hurt, guiding how fast the fix must ship, independent of scheduling realities. | • Critical: crash, data loss, security • High: core feature wrong, no workaround • Medium: degraded UX/perf, workaround exists • Low: cosmetic, minor style, informational |