Introducing SDD structure for Services Page#306
Open
mariana-caldas wants to merge 16 commits into
Open
Conversation
The package is no longer actively maintained
lint-staged from v17.0.0 requires installing it manually ref: https://github.com/lint-staged/lint-staged/releases/tag/v17.0.0
This aligns the image format with the other members'
chore: Release v1.5.0
✅ Deploy Preview for webdevpathstage ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
mariana-caldas
requested review from
Satoshi-Sh,
bernardoasc,
briangesteban,
cherylli,
emersonmellado,
klezi10,
luke-buttifant,
midnightmoet,
oluwatobiss and
sergiobtos
mariana-caldas
requested review from
LuSilvaDeveloper,
Mamooe94,
dami-boy,
mtkksk1780 and
shayla-develops-webs
and removed request for
midnightmoet
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
2 participants
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.
Have you updated the CHANGELOG.md file? If not, please do it.
Yes.
What is this change?
This pull request introduces a lightweight Specification-Driven Development (SDD) structure for the Services Page initiative.
Added:
/specs/services-page/specification.md/specs/services-page/decisions.md/specs/services-page/tasks.md/specs/services-page/references.mdTogether, these documents create a shared source of truth for the initiative by capturing:
The goal is to reduce ambiguity, improve onboarding, and provide implementation context before development begins.
This approach is increasingly common in AI-assisted development workflows because tools such as Claude, GitHub Copilot, Cursor, and ChatGPT perform significantly better when they receive structured project context instead of isolated implementation requests.
For example, instead of prompting:
contributors can provide
specification.md,decisions.md,references.md, and correspondent task while asking the AI assistant to implement the Hero section according to the documented requirements and constraints.This allows AI tools to understand business goals, design constraints, implementation decisions, and project context before generating code.
Were there any complications while making this change?
No technical complications.
The primary challenge was defining a lightweight structure that provides value without introducing unnecessary process overhead for contributors.
Rather than adopting the complete GitHub Spec Kit workflow, this implementation focuses on four core documents:
How to test this PR?
Review the newly created files:
/specs/services-page/specification.md/specs/services-page/decisions.md/specs/services-page/tasks.md/specs/services-page/references.mdValidate that:
When should this be merged?
After at least 3 reviews from the team.
Once approved, Project Managers will use the documented tasks as a starting point for creating GitHub Issues.
The tasks file is intended to guide planning and prioritization, while GitHub Issues will remain the primary mechanism for assigning, tracking, and delivering implementation work.
This should be merged before implementation begins on the Services Page so contributors can use the specifications as the primary implementation reference.