Skip to content

issue-documentation-checklist.md

Latest commit

 

History

History
35 lines (25 loc) · 1.29 KB

issue-documentation-checklist.md

File metadata and controls

35 lines (25 loc) · 1.29 KB
Raw

Issue documentation checklist

Copy the block below into feature issues when work might touch project structure. Agents and developers use the same rules as AGENTS.md — Project documentation.

When to update docs/architecture.md

Update the relevant section only (small diff) when the issue:

  • Adds or moves a composable/util area or module boundary
  • Changes where a major user flow is wired (new page, new pipeline step)
  • Refactors file locations (#63-style splits) that agents would look up by path

When docs are not needed

Note in the issue Notes with one line, for example:

  • Docs: N/A — bugfix in existing function, no path changes
  • Docs: N/A — copy/i18n only
  • Docs: N/A — test-only change

Snippet for GitHub issues

## Documentation checklist
- [ ] Structural change? Update `docs/architecture.md` (relevant section only)
- [ ] If no doc change: note in **Notes**: `Docs: N/A — …`
- [ ] User-visible change logged in CHANGELOG under `[Unreleased]`:
  read file until last `## [version]` release; use existing `### Added` /
  `### Changed` / `### Fixed` blocks; prepend bullet at top of the right
  subsection (never nest `### Fixed` inside `### Added`)

Main map: architecture.md. Hub: README.md.