docs(contributing): follow spec lifecycle for goals#108
Merged
angelicawill merged 6 commits intomainfrom Apr 29, 2026
Merged
Conversation
This comment was marked as resolved.
This comment was marked as resolved.
Time Submission Status
You can submit time with the command. Example: See available commands to help comply with our Guidelines. |
Contributor
There was a problem hiding this comment.
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
📒 Files selected for processing (1)
docs/CONTRIBUTING.md
Member
Author
|
@holdex pr submit-time 3h 25m |
angelicawill
approved these changes
Apr 29, 2026
Contributor
|
@holdex pr submit-time 7m |
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.
Summary
docs/specs/as the canonical location for forward-looking Goal specsdocs/, unimplemented stay indocs/specs/## Designsection) instead of a standaloneDESIGN.mdTest plan
Summary by CodeRabbit