chore: add technical-writer skill and require it for repo prose - #168
Merged
Merged
Conversation
Add the technical-writer skill under .agents/skills, with .claude linked to .agents so Claude Code loads it too. Require it in AGENTS.md, CONTRIBUTING.md, and the PR and issue templates.
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Thank you for following the naming conventions! 🙏 |
This branch was successfully deployed
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.
Adds the
technical-writerskill to.agents/skillsand requires it for prose written in this repo: READMEs, changesets, commit messages, PR titles and bodies, and issues. The skill sets the voice, lists patterns to cut (filler, hype, bold emphasis, em dashes, negation-and-reveal), and asks writers to check technical claims against the source before stating them. It complements the existing "Code style — no slop" rules, which already extend to all prose..claudeis a symlink to.agents, so Claude Code loads the skill from.claude/skillswhile other agents read.agents/skills. This is the same layout vercel/chat uses for the same skill (vercel/chat#976).Where the requirement appears:
AGENTS.md: a bullet under "Code style — no slop"..github/CONTRIBUTING.md: a "Writing with AI coding agents" section under "Pull requests"..github/pull_request_template.md: a hidden comment telling agents to use the skill for the description and commit messages.#comment that GitHub doesn't display.The docs site and the published
github-tools-agentsskill are unchanged. No changeset, since the published packages aren't touched.pnpm lintpasses.