From fa3e5e61b4f802851f35c7755e1bd6aa44c797eb Mon Sep 17 00:00:00 2001 From: Amolith Date: Tue, 17 Feb 2026 10:15:18 -0700 Subject: [PATCH] docs(agents): standardize skill listing tense --- AGENTS.md | 13 +++++++++++++ README.md | 56 ++++++++++++++++++++++++++++--------------------------- 2 files changed, 42 insertions(+), 27 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index ac43ace71b72f704ad82c24361d81387d945fd40..d9034f5c2136815d3bfdfe2a8982a446dc43f5df 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -18,6 +18,19 @@ skills/skill-name/ The `skills/authoring-skills/` directory has the necessary info for, well, authoring skills. +## Listing Skills in README.md + +When adding a new skill, include an entry in the "Available Skills" section of README.md. Entries should be: + +- **Third-person present tense**: "Writes", "Creates", "Queries" — describes what the skill does +- **Concise**: Tight paragraph that conveys the capability +- **Human-oriented**: A human can read it and understand what the skill will make the agent do + +Example pattern: +- "Creates commits following Conventional Commits format via git-format." + +Sort entries alphabetically by skill name. + ## Naming Convention Two categories of skills exist: diff --git a/README.md b/README.md index 32f50f25cb33b4993968499888406869e366c3b7..967e6d940eb9b0a04c2403db122ecb261d25e5a4 100644 --- a/README.md +++ b/README.md @@ -26,66 +26,68 @@ token count, plus overall metadata usage. I've used and tested them most with - [addressing-agent-comments](skills/addressing-agent-comments/SKILL.md): Finds `AGENT:` comments in code, gathers feedback, and carries out requested changes. -- [ast-grep](skills/ast-grep/SKILL.md): Write [ast-grep] rules for structural - code search and analysis. Find patterns the way the compiler sees them, not - just as text. -- [authoring-skills](skills/authoring-skills/SKILL.md): Create and review Agent - Skills following best practices. Covers skill structure, frontmatter, and - progressive disclosure patterns. +- [ast-grep](skills/ast-grep/SKILL.md): Writes [ast-grep] rules for structural + code search and modification. +- [auditing-repositories](skills/auditing-repositories/SKILL.md): Audits open + source repositories for security, privacy, and unexpected behavior. +- [authoring-skills](skills/authoring-skills/SKILL.md): Creates and reviews + Agent Skills following best practices. Covers skill structure, frontmatter, + and progressive disclosure patterns. - [creating-tasks-through-lunatask](skills/creating-tasks-through-lunatask/SKILL.md): - Create tasks and handoffs in [Lunatask] via [lune]. Tasks are just tasks. + Creates tasks and handoffs in [Lunatask] via [lune]. Tasks are just tasks. Handoffs capture work to resume later across sessions without filling context windows. -- [formatting-commits](skills/formatting-commits/SKILL.md): Create commits +- [formatting-commits](skills/formatting-commits/SKILL.md): Creates commits following Conventional Commits format via [git-format]. -- [frontend-accessibility](skills/frontend-accessibility/SKILL.md): Generate - accessible HTML, React, and frontend code following WCAG 2.2 AA. Prioritizes - semantic HTML over ARIA, keyboard navigation, and screen reader compatibility. -- [handling-customer-data](skills/handling-customer-data/SKILL.md): Query +- [frontend-accessibility](skills/frontend-accessibility/SKILL.md): Strives to + generate accessible HTML, React, and frontend code following WCAG 2.2 AA. + Prioritizes semantic HTML over ARIA, keyboard navigation, and screen reader + compatibility. +- [handling-customer-data](skills/handling-customer-data/SKILL.md): Queries customer data responsibly—the agent answers questions about the data without ever seeing it directly. -- [humanizer](skills/humanizer/SKILL.md): Remove AI-generated patterns from text +- [humanizer](skills/humanizer/SKILL.md): Removes AI-generated patterns from text like promotional fluff, weasel words, and mechanical sentence structures. Based on Wikipedia's AI Cleanup research. Originally from [blader/humanizer]. -- [invoking-subagents](skills/invoking-subagents/SKILL.md): Spawn subagents with +- [invoking-subagents](skills/invoking-subagents/SKILL.md): Spawns subagents with restricted tool access for parallel tasks across repositories. Requires [synu] and the `claude` CLI. Useful for summarizing git history or processing large diffs without filling the main context window. - [managing-and-navigating-worktrees](skills/managing-and-navigating-worktrees/SKILL.md): - Git worktree management using [wt] with a bare repository structure. Each + Manages git worktrees using [wt] with a bare repository structure. Each branch lives in its own sibling directory. Requires [wt], git, and [gum]. -- [notifying-through-ntfy](skills/notifying-through-ntfy/SKILL.md): Send push - notifications via [ntfy.sh] when the user asks to be notified. +- [notifying-through-ntfy](skills/notifying-through-ntfy/SKILL.md): Sends push + notifications via [ntfy.sh] when requested, such as at the end of its turn. - [querying-documentation](skills/querying-documentation/SKILL.md): Query Go documentation with focused subagents for complex questions spanning multiple packages or external libraries. Requires Fish shell and [synu]. Currently Go-only. -- [rebasing-with-git](skills/rebasing-with-git/SKILL.md): Git rebase workflows +- [rebasing-with-git](skills/rebasing-with-git/SKILL.md): Manages git rebase workflows from simple rebases to the drop-and-repick integration branch pattern. Assumes `upstream` remote for forks and `rerere` enabled. Supports worktrees including `wt`-managed repos. -- [researching-with-rumilo](skills/researching-with-rumilo/SKILL.md): Dispatch AI +- [researching-with-rumilo](skills/researching-with-rumilo/SKILL.md): Dispatches AI research subagents via [rumilo] for web search and repository exploration. Research topics, look up library usage, or explore external codebases without filling the main context window. - [resuming-work-through-lunatask](skills/resuming-work-through-lunatask/SKILL.md): - Resume deferred work from [Lunatask] handoff notes via [lune]. -- [reviewing-code](skills/reviewing-code/SKILL.md): Review code for correctness, + Resumes deferred work from [Lunatask] handoff notes via [lune]. +- [reviewing-code](skills/reviewing-code/SKILL.md): Reviews code for correctness, security, reliability, performance, and quality. Covers PRs, diffs, and general change review. -- [scripting-with-go](skills/scripting-with-go/SKILL.md): Create executable Go +- [scripting-with-go](skills/scripting-with-go/SKILL.md): Creates executable Go scripts using a shell trick (not a true shebang). For automation and tooling outside of Go projects. -- [working-with-tmux](skills/working-with-tmux/SKILL.md): Spawn and manage - background processes via tmux. Create windows, send commands, and capture +- [working-with-tmux](skills/working-with-tmux/SKILL.md): Spawns and manages + background processes via tmux. Creates windows, sends commands, and captures output without blocking the main session. Useful for servers and long tasks. -- [writing-git-tags](skills/writing-git-tags/SKILL.md): Generate git tag +- [writing-git-tags](skills/writing-git-tags/SKILL.md): Generates git tag annotations from commit history following Semantic Versioning and Conventional Commits via [git-format]. -- [writing-roc-lang](skills/writing-roc-lang/SKILL.md): Write Roc code with +- [writing-roc-lang](skills/writing-roc-lang/SKILL.md): Writes Roc code with strong static types, helpful compiler errors, and functional programming. Covers both full applications and one-off scripts. -- [writing-rust](skills/writing-rust/SKILL.md): Write idiomatic Rust with strict +- [writing-rust](skills/writing-rust/SKILL.md): Writes idiomatic Rust with strict quality gates: `cargo fmt`, `clippy -- -D warnings`, and required tests. Enforces `thiserror` for libs, `anyhow` for apps, warns against common anti-patterns.