This folder contains reusable skill definitions for package review workflows.
Each subfolder under .github/skills/ contains a single skill, defined in a
SKILL.md file. Skills capture the domain expertise and style guidance used by
review agents.
proofread-comments— Review roxygen2 documentation and inline comments in R source files.proofread-docs— Review narrative documentation prose in README, vignettes, and other top-level docs.
- Skill folders are named after the
name:field in the skill manifest. - Each skill folder must contain one
SKILL.mdfile. - Skill manifests use markdown with a YAML frontmatter section for metadata.
- Keep skill guidance focused on prose, documentation, and review guidance, not code execution.
- Use
nameanddescriptionconsistently between the folder name and the skill metadata.
SKILL.mdYAML frontmatter should include:name: the skill identifierdescription: a short summary of the skill's expertise
- Keep the skill folder name aligned with the
namefield. - When adding a new skill, update this README and any agent README that references it.
- Agents may optionally use an explicit
skills:declaration in.agent.mdto list the skill names they rely on.
- Add a new skill when a new review area is needed.
- Name the folder and
name:field consistently. - Keep skill guidance scoped and easy to follow.
- If an agent is created, reference the corresponding skill name in the agent manifest.
- Agents are defined separately in
.github/agents/and should point to the appropriate skill(s). - This file is intended to help maintainers understand the
.github/skills/layout and add new review skills consistently.