Skip to content

📝 docs(specs): define standard spec format and conventions#79

Merged
szmyty merged 2 commits intomainfrom
copilot/define-spec-format-conventions
Apr 3, 2026
Merged

📝 docs(specs): define standard spec format and conventions#79
szmyty merged 2 commits intomainfrom
copilot/define-spec-format-conventions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 3, 2026

Specs lacked a canonical format, had two divergent templates, and no explicit rules on required sections, level of detail, or AI readability — making them unreliable inputs for agents and inconsistent across the repo.

Changes

specs/_template.md — single canonical template

  • Added Inputs and Outputs tables (type, required, validation rules)
  • Expanded Behavior into three mandatory subsections: Happy Path, Edge Cases & Alternate Flows, Error Handling
  • Added Constraints section (performance, security, accessibility, platform, dependencies)

specs/README.md — authoritative conventions reference

  • Required vs. Optional Sections table — explicit per-section status and purpose
  • Level of Detail guidelines — concrete rules for behavior descriptions, acceptance criteria, inputs/outputs, and constraints; bans vague language like "works correctly"
  • AI Readability guidelines — structured lists over prose, consistent terminology, explicit links, one criterion per bullet
  • Tightened File Naming to note _-prefixed files are reserved for meta/tooling

specs/templates/feature.spec.md — removed

Redundant alternate template; best content absorbed into _template.md. Having two templates was the root cause of inconsistency.

CONTRIBUTING.md — added Feature Specifications section

Five-step summary of the spec-driven workflow with an explicit callout that incomplete or vague specs produce incorrect AI implementations.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 3, 2026

@szmyty Unfortunately, I hit an error while trying to use the custom Copilot setup steps configured for this repository and had to close this PR. The error I am seeing is:

no `copilot-setup-steps` job found in your `copilot-setup-steps.yml` workflow file. Please ensure you have a single job named `copilot-setup-steps`. For more details, see https://gh.io/copilot/actions-setup-steps

Once you or someone with the necessary access fixes the problem, please unassign and then reassign issue #0 to me and I'll retry. Thanks!

Copilot AI changed the title [WIP] Define standard specification format and conventions for the repository 📝 docs(specs): define standard spec format and conventions Apr 3, 2026
Copilot AI requested a review from szmyty April 3, 2026 03:52
@szmyty szmyty marked this pull request as ready for review April 3, 2026 05:05
@szmyty szmyty merged commit 9df63b9 into main Apr 3, 2026
@szmyty szmyty deleted the copilot/define-spec-format-conventions branch April 3, 2026 05:05
@devactivity-app
Copy link
Copy Markdown

Pull Request Summary by devActivity

Metrics

Cycle Time: 1h 18m Pickup Time: 1h 13m Review Time: < 1 min Comments: 1

Achievements

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.

🧠 Define standard spec format and conventions for the repository

2 participants