microsoft / microsoft/devsquad-copilot
[documentation-style] Explicitly forbid the em-dash character
Open
Beginner friendly
Nobody has claimed this yet.
documentation
- Dominant language
- No language data
- Stars
- 44
- Forks
- 10
- Avg merge
- 6h 49m
- Merged PRs (30d)
- 1
Description
The current rule bans hyphens/dashes only when used as separators between concepts. Extend it to forbid the literal em-dash character outright.
Current rules:
.github/instructions/documentation-style.instructions.mdline 11.github/skills/documentation-style/SKILL.mdline 13
Acceptance criteria
- Both files state the em-dash character must not be used at all.
- Guidance to rewrite the sentence instead.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with .github/instructions/documentation-style.instructions.md line 11 and .github/skills/documentation-style/SKILL.md line 13. Update both rules so the literal em-dash character is forbidden in all uses and instructs writers to rewrite the sentence instead. Done means both files contain the same guidance and no other behavior is changed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100