8000 docs: specs live in the repo, one folder per ticket by simon-inkie · Pull Request #149 · simon-inkie/inkie-deck · GitHub
[go: up one dir, main page]

Skip to content

docs: specs live in the repo, one folder per ticket - #149

Merged
simon-inkie merged 1 commit into
mainfrom
docs/specs-live-in-the-repo
Nov 18, 2026
Merged

simon-inkie merged 1 commit into
mainfrom
docs/specs-live-in-the-repo

Conversation

@simon-inkie
@simon-inkie simon-inkie commented Nov 18, 2026 •
Copy link
Copy Markdown
Owner

What

States the spec rule where agents and new contributors look first: every ticket gets a folder .specs/<issue-number>-<slug>/ holding its SPEC.md and any design notes, in the same pull request as the code, and a spec is never kept only in a chat, a ticket comment or a wiki.

  • CLAUDE.md, AGENTS.md, CONTRIBUTING.md: one short rule each, pointing at DEVELOPMENT.md section 2.
  • DEVELOPMENT.md section 2: before an issue number exists the folder is .specs/<slug>/; rename it with git mv when the issue is created and record the number in the SPEC header.

The convention already existed in DEVELOPMENT.md; this makes it visible. Docs only, 19 insertions.

Review

Wording reviewed by a maintainer-side reviewer; leak and dash checks clean. No code, so no tests run. No issue yet.

🤖 Generated with Claude Code

Signed-off-by: Simon Dixon <simon-inkie@users.noreply.github.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@simon-inkie
simon-inkie merged commit a09fa26 into main Nov 18, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

0