📝 docs(specs): define standard spec format and conventions#79
Merged
Conversation
Contributor
Author
|
@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: 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! |
Agent-Logs-Url: https://github.com/egohygiene/flutter-foundation/sessions/0151fe4a-f91a-4d45-ba24-cd4970935a83 Co-authored-by: szmyty <14865041+szmyty@users.noreply.github.com>
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
szmyty
approved these changes
Apr 3, 2026
Pull Request Summary by devActivityMetricsAchievements
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 templatespecs/README.md— authoritative conventions reference_-prefixed files are reserved for meta/toolingspecs/templates/feature.spec.md— removedRedundant alternate template; best content absorbed into
_template.md. Having two templates was the root cause of inconsistency.CONTRIBUTING.md— added Feature Specifications sectionFive-step summary of the spec-driven workflow with an explicit callout that incomplete or vague specs produce incorrect AI implementations.