Skip to content

docs(contributing): follow spec lifecycle for goals#108

Merged
angelicawill merged 6 commits intomainfrom
docs/specs-workflow
Apr 29, 2026
Merged

docs(contributing): follow spec lifecycle for goals#108
angelicawill merged 6 commits intomainfrom
docs/specs-workflow

Conversation

@zolotokrylin
Copy link
Copy Markdown
Member

@zolotokrylin zolotokrylin commented Apr 29, 2026

Summary

  • Introduces docs/specs/ as the canonical location for forward-looking Goal specs
  • Specs shrink as PRs land — implemented sections move to docs/, unimplemented stay in docs/specs/
  • Figma design links move into the Spec file (## Design section) instead of a standalone DESIGN.md
  • Google Document remains an option for external stakeholder collaboration

Test plan

  • Read through the new Specs section and verify the lifecycle is clear
  • Verify the Design PRs section correctly references the Spec file
  • Confirm PR checklist item for spec graduation is actionable

Summary by CodeRabbit

  • Documentation
    • Introduced a new specifications documentation framework for contributors, including updated guidance on linking specifications to goals and managing documentation lifecycle across the contributing process.

@coderabbitai

This comment was marked as resolved.

@holdex
Copy link
Copy Markdown

holdex Bot commented Apr 29, 2026

Time Submission Status

Member Status Time Action Last Update
zolotokrylin ✅ Submitted 3h Update time Apr 29, 2026, 8:56 AM
angelicawill ✅ Submitted 7min Update time Apr 29, 2026, 8:56 AM

You can submit time with the command. Example:

@holdex pr submit-time 15m

See available commands to help comply with our Guidelines.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/CONTRIBUTING.md (1)

143-144: Wrap long lines to keep markdown lint-clean.

These lines exceed the configured length (MD013). Not functionally blocking, but worth normalizing.

Proposed fix
-Never add unimplemented behavior to `docs/`. Never leave implemented behavior
-in `docs/specs/`.
+Never add unimplemented behavior to `docs/`.
+Never leave implemented behavior in `docs/specs/`.
-- [ ] Spec sections moved to `docs/` for any behavior this PR delivers (if applicable)
+- [ ] Spec sections moved to `docs/` for any behavior this PR delivers
+      (if applicable)

Also applies to: 247-247

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/CONTRIBUTING.md` around lines 143 - 144, The markdown has long lines
that trigger MD013 (line-wrapping) — specifically the sentence "Never add
unimplemented behavior to `docs/`. Never leave implemented behavior in
`docs/specs/`." (and a duplicate around line 247); fix by wrapping these
sentences to the project's max line length (wrap at natural punctuation or
between clauses so code spans remain intact), ensuring each wrapped line is
under the linter limit and that backticks/code spans are not broken, then save
the CONTRIBUTING.md change.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/CONTRIBUTING.md`:
- Around line 138-141: The fenced code block in the CONTRIBUTING.md snippet (the
triple-backtick fence around the two example paths) is missing a language
identifier; update the opening fence used for the example lines
`docs/specs/<feature>.md   ← only unimplemented sections` and `docs/<feature>.md
← only what is currently shipped` to include a language (e.g., use ```text) so
markdownlint rule MD040 is satisfied and the block displays as plain text.

---

Nitpick comments:
In `@docs/CONTRIBUTING.md`:
- Around line 143-144: The markdown has long lines that trigger MD013
(line-wrapping) — specifically the sentence "Never add unimplemented behavior to
`docs/`. Never leave implemented behavior in `docs/specs/`." (and a duplicate
around line 247); fix by wrapping these sentences to the project's max line
length (wrap at natural punctuation or between clauses so code spans remain
intact), ensuring each wrapped line is under the linter limit and that
backticks/code spans are not broken, then save the CONTRIBUTING.md change.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2f8f9871-8368-4511-8b9b-94a520d5aceb

📥 Commits

Reviewing files that changed from the base of the PR and between 477adb2 and 7dc75dd.

📒 Files selected for processing (1)
  • docs/CONTRIBUTING.md

Comment thread docs/CONTRIBUTING.md Outdated
@zolotokrylin
Copy link
Copy Markdown
Member Author

@holdex pr submit-time 3h 25m

@zolotokrylin zolotokrylin requested a review from markholdex April 29, 2026 06:42
@angelicawill
Copy link
Copy Markdown
Contributor

@holdex pr submit-time 7m

@angelicawill angelicawill merged commit cebedcd into main Apr 29, 2026
4 checks passed
@angelicawill angelicawill deleted the docs/specs-workflow branch April 29, 2026 08:56
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.

2 participants