pal-e-docs

Issue Template: Spike

template-issue-spike Template

active template
Project

Issue Template: Spike

Use this template for time-boxed investigations with unclear scope. A spike produces two concrete artifacts: a docs/ file (the durable knowledge) and follow-up tickets (the scoped work). If the answer is "no action needed," the docs file explains why.

When to Use

  • Root cause is unknown — need investigation before scoping a fix
  • Multiple possible approaches — need to evaluate before committing
  • New technology or integration — need to prove feasibility
  • Scope is unclear — need exploration before writing acceptance criteria

What Makes Spikes Different

Feature/Bug Spike
Output is code (PR) Output is docs + tickets (PR is docs-only)
Has File Targets File target is <code>docs/{topic}.md</code>
Has Test Expectations No Test Expectations (nothing to test yet)
Has detailed Acceptance Criteria Has Deliverables (concrete artifacts produced)
Open-ended timeline Time-boxed (prevent rabbit holes)

Forgejo Issue Template

Spike Outcomes

  • Scoped follow-up: Spike answered the question → docs file merged, follow-up Feature or Bug tickets created with known scope. Link back to spike.
  • No action: Investigation showed the concern is unfounded or self-resolving. Docs file still gets written explaining why — "no action" is a decision that deserves rationale, not a closing comment.
  • Escalate: Time-box expired or decision is above agent pay grade. Docs file captures findings so far, presents options to Lucas.
  • template-issue-feature — feature variant (use when spike produces a scoped follow-up)
  • template-issue-bug — bug variant
  • template-issue — canonical issue design principle
  • convention-todo-lifecycle — lifecycle and triage rules