Commit Graph

19 Commits

Author SHA1 Message Date
Manfred Riem
e3bcefdfcb docs: remove git branch implementation detail from Article VI
Spec versioning is now tool-agnostic: 'versioned and reviewable
before acceptance' rather than prescribing branch-based workflows.
2026-05-11 09:40:24 -05:00
Manfred Riem
25175e2121 docs: recommend versioning models for constitution and specs
Constitution uses semantic versioning (major/minor/patch).
Specifications use branch-based workflows (feature branches,
reviewed and merged like code). Consistent with the existing
description in spec-driven.md line 21.
2026-05-11 09:39:31 -05:00
Manfred Riem
6fec3aa13d docs: make Article VI neutral across workflow approaches
Support all three schools: new spec, update existing spec, or
regenerate derived artifacts. The only invariant is that specs
drive implementation, not the reverse, and gaps are addressed
through specifications rather than untracked code changes.
2026-05-11 09:38:17 -05:00
Manfred Riem
fbb41195b4 docs: revise Article VI to establish spec as source of truth
Constitution and specifications are the versioned sources of truth.
Plans and tasks are derived execution artifacts. Implementation gaps
are addressed through new specifications, preserving the feed-forward
dependency direction rather than retrofitting code back into specs.
2026-05-11 09:36:12 -05:00
Manfred Riem
058256758f docs: broaden Article VI beyond constitution-only versioning
Article VI now covers governance and versioning of all project
artifacts (constitution, specs, plans, tasks), not just constitution
amendments. This matches what spec-driven.md itself describes:
specifications versioned in branches, requirement changes propagating
across artifacts, and cross-artifact consistency.
2026-05-11 09:28:59 -05:00
Manfred Riem
85fc96b284 docs: align Articles IV-V language with existing article style
Replace 'clarification pipeline' tooling references with
principle-effect language matching Articles I-III and VII-IX.
2026-05-11 09:27:02 -05:00
Manfred Riem
8f87999daf docs: remove /speckit.* command references from Articles IV-VI
Match the style of existing articles which state principles and
rationale without referencing specific Spec Kit commands.
2026-05-11 09:26:13 -05:00
Manfred Riem
423e104835 docs: define Articles IV, V, VI in spec-driven.md
Article IV (Requirement Quality and Coverage): driven by the
clarify/checklist/analyze pipeline that validates requirement
completeness, ambiguity, and traceability before planning.

Article V (Non-Functional Standards): ensures projects explicitly
specify performance, security, observability, and accessibility
requirements rather than defaulting to functional-only output.

Article VI (Governance and Versioning): codifies constitution
versioning and cross-artifact consistency propagation via the
/speckit.constitution command.

These three articles were missing from the original document despite
being actively enforced by existing templates and commands. Derived
by mapping every template and command back to constitutional
principles and identifying enforcement mechanisms with no article.
2026-05-11 09:25:24 -05:00
alex-zwingli
f92e7e8096 fix: accept 4+ digit spec numbers in tests and docs (#2094)
Two test assertions in test_timestamp_branches.py used the regex
`\d{3}` (exactly 3 digits) instead of `\d{3,}` (3 or more digits).
While the underlying shell scripts already handle spec numbers ≥ 1000
correctly — printf "%03d" and PowerShell '{0:000}' both expand naturally
beyond 3 digits, and all detection regexes use {3,} — the overly-strict
test assertions would fail with a misleading error if a fixture ever
contained 1000+ spec directories.

Documentation in README.md, spec-driven.md, and the CLI --branch-numbering
help text implied that sequential spec numbers are always 3 digits, which
could lead users to believe a hard limit of 999 exists.

Changes:
- tests/test_timestamp_branches.py: change two \d{3} assertions to \d{3,}
- src/specify_cli/__init__.py: clarify help text to show numbers expand past 999
- README.md: update --branch-numbering docs to note numbers expand beyond 3 digits
- spec-driven.md: update feature numbering description to include 4-digit example

Fixes #2093

Co-authored-by: alex-zwingli <alex-zwingli@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-04-06 08:26:26 -05:00
den (work)
3e883fa32c Update Markdown formatting 2025-12-04 11:50:36 -08:00
Benjamin Pahl
33a07969c3 feat(ci): add markdownlint-cli2 for consistent markdown formatting
Add automated markdown linting to ensure consistent formatting across
all markdown files in the repository.

Changes:
- Add .markdownlint-cli2.jsonc configuration
- Create .github/workflows/lint.yml for CI/CD integration
- Fix all 908 existing markdown errors across 27 files
- Enforce ATX-style headings and asterisk emphasis
- Set consistent 2-space list indentation

This prevents markdown errors after project initialization and
maintains high documentation quality standards.
2025-10-20 00:49:15 +02:00
den (work)
36ff7e6505 Update files 2025-10-14 11:52:26 -07:00
den (work)
15e5572a1d Update command reference 2025-10-06 22:16:48 -07:00
Pengkui Luo
919bda2355 docs: fix grammar mistakes in markdown files 2025-09-17 20:36:30 -07:00
Mark Beacom
167038ca3c docs: Update Commands sections renaming to match implementation 2025-09-09 15:13:27 -04:00
Riya Amemiya
6cade67360 fix: correct typos in spec-driven.md
- Fixed spelling: substraction → subtraction
- Fixed spelling: eviolve → evolve
- Fixed grammar: re-implement of change → re-implement or change
2025-09-05 12:04:22 +09:00
Govind Kamtamneni
f077e90a24 fix minor typo in Article I 2025-09-04 13:46:36 +00:00
Lucas Modrich
81fea96e42 doco(spec-driven): Fix small typo in document 2025-09-03 10:58:10 +10:00
Den Delimarsky 🌺
28fdfaa869 Initial checkin 2025-08-22 10:06:25 -07:00