fix(gdc): clarify prose wrapping rule#104
Open
puneetdixit200 wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the shared “General Doc Constraints” (GDC) prose-wrapping guidance to remove ambiguity that led agents to insert hard line breaks for visual wrapping, and aligns the documentation-review checklist to flag hard-wrapped output.
Changes:
- Reworded the GDC Prose rule to explicitly prohibit hard newlines used for visual wrapping and require single-line paragraphs.
- Bumped embedded GDC footer references from v1.1.0 to v1.1.1 across skills (and the canonical asset copy).
- Updated the documentation-review “Output quality” checklist wording to flag hard-wrapped prose/bullets rather than “soft-wrapped” output.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
.agents/skills/skill-creation/SKILL.md |
Updates embedded GDC prose rule + footer version to v1.1.1. |
.agents/skills/skill-creation/assets/general-doc-constraints.md |
Updates canonical GDC prose rule + footer version to v1.1.1. |
.agents/skills/readme-creation/SKILL.md |
Updates embedded GDC prose rule + footer version to v1.1.1. |
.agents/skills/pull-merge-request-creation/SKILL.md |
Updates embedded GDC prose rule + footer version to v1.1.1. |
.agents/skills/next-session-handoff/SKILL.md |
Updates embedded GDC prose rule + footer version to v1.1.1. |
.agents/skills/meeting-memo-creation/SKILL.md |
Updates embedded GDC prose rule + footer version to v1.1.1. |
.agents/skills/meeting-agenda-creation/SKILL.md |
Updates embedded GDC prose rule + footer version to v1.1.1. |
.agents/skills/living-design-documents/SKILL.md |
Updates embedded GDC prose rule + footer version to v1.1.1. |
.agents/skills/issue-creation/SKILL.md |
Updates embedded GDC prose rule + footer version to v1.1.1. |
.agents/skills/dot-gitlab-sync/SKILL.md |
Updates embedded GDC prose rule + footer version to v1.1.1. |
.agents/skills/documentation-review/SKILL.md |
Updates checklist wording to flag hard-wrapping; updates embedded GDC prose rule + footer version. |
.agents/skills/documentation-review/README.md |
Updates checklist wording to flag hard-wrapping in the skill’s README. |
.agents/skills/contacts-management/SKILL.md |
Updates embedded GDC prose rule + footer version to v1.1.1. |
.agents/skills/commit-message-creation/SKILL.md |
Updates embedded GDC prose rule + footer version to v1.1.1. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Clarifies the General Doc Constraints prose wrapping rule so agents do not insert hard newlines to simulate editor wrapping. Also updates the documentation-review checklist to flag hard-wrapped output instead of listing soft-wrapped output as a problem.
AI-assisted contribution: created with OpenAI Codex and manually reviewed.
closes #100
Changes
Impact
Notes
git diff --checkpassed..agents.