Add usethis-agents skill with auto-generated skills directory#1630
Merged
nathanjmcdougall merged 4 commits intomainfrom Mar 29, 2026
Merged
Add usethis-agents skill with auto-generated skills directory#1630nathanjmcdougall merged 4 commits intomainfrom
usethis-agents skill with auto-generated skills directory#1630nathanjmcdougall merged 4 commits intomainfrom
Conversation
- Create hooks/export-skills-directory.py to extract skill names and descriptions from SKILL.md frontmatter into docs/skills-directory.txt - Create .agents/skills/usethis-agents/SKILL.md explaining the one-source-of-truth principle and AGENTS.md maintenance - Add export-skills-directory hook to .pre-commit-config.yaml - Add SKILL.md to check-doc-sync args for sync block validation - Add usethis-agents to AGENTS.md skills registry table - Generate initial docs/skills-directory.txt Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/d2aeb693-d94b-4c01-a3ba-b935ad3d85c0 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add usethis-agents skill for automated docstring reference
Add Mar 29, 2026
usethis-agents skill with auto-generated skills directory
nathanjmcdougall
requested changes
Mar 29, 2026
|
|
||
| The usethis-specific skills table in `AGENTS.md` must include every skill directory under `.agents/skills/` that starts with `usethis-`. The `check-skills-documented` hook enforces this. When creating a new skill, add it to the table (see the `usethis-skills-create` skill for the full procedure). | ||
|
|
||
| ## Skills Directory |
Collaborator
There was a problem hiding this comment.
@copilot don't include the skills directory in this file. I don't want you to mention usethis in this file, just the .agent/skills dir more generically.
Contributor
Author
There was a problem hiding this comment.
Removed the skills directory table and made the content generic in cbce013. The SKILL.md now describes the one-source-of-truth principle and AGENTS.md maintenance without usethis-specific references — just .agents/skills/ generically. Also removed the SKILL.md from check-doc-sync args since it no longer has sync blocks.
…agents SKILL.md Make the skill content generic: describe the one-source-of-truth principle and AGENTS.md maintenance without usethis-specific examples or embedding the skills directory table. Remove SKILL.md from check-doc-sync args since it no longer has sync blocks. Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/302a3e52-f9ad-432d-be31-b887e9ccb2f1 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
nathanjmcdougall
requested changes
Mar 29, 2026
| @@ -0,0 +1,43 @@ | |||
| --- | |||
| name: usethis-agents | |||
| description: Maintain AGENTS.md and agent skill configuration following the one-source-of-truth principle | |||
Collaborator
There was a problem hiding this comment.
Let's keep the description more general:
" Maintain AGENTS.md and agent skill configuration "
i.e. remove mention of the one-source-of-truth principle
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
- Change SKILL.md description to "Maintain AGENTS.md and agent skill configuration" (remove one-source-of-truth mention) - Convert skills directory from table to bullet-point format in both the export hook and generated docs/skills-directory.txt - Wrap usethis-specific skills in AGENTS.md with sync markers for docs/skills-directory.txt Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/771b656a-119e-447c-9562-00cb146df84d Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
nathanjmcdougall
approved these changes
Mar 29, 2026
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.
Agent reference material (function lists, module trees, skill directories) should be extracted from source via automation hooks, not maintained by hand. This PR codifies that principle as a skill and applies it to the skills directory itself.
New skill:
usethis-agentsDocuments the one-source-of-truth principle for agent configuration: use docstrings/frontmatter as the canonical source and prek hooks to extract them into
docs/files, synced into markdown via<!-- sync:path -->markers.Covers:
AGENTS.mdmaintenance (sync blocks, skills registry, validation hooks)The skill content is kept generic — it describes the principle and procedures without project-specific references, referring only to
.agents/skills/generically.New hook:
export-skills-directoryhooks/export-skills-directory.pyscans.agents/skills/usethis-*/SKILL.md, extractsnameanddescriptionfrom YAML frontmatter, writes a Markdown bullet list todocs/skills-directory.txtexport-module-tree.py— same CLI pattern (--skills-dir,--output-file,--prefix)Config changes
.pre-commit-config.yaml: addedexport-skills-directoryhookAGENTS.md: addedusethis-agentsto skills registry; usethis-specific skills section now uses<!-- sync:docs/skills-directory.txt -->markers to stay in sync with the generated file⌨️ Start Copilot coding agent tasks without leaving your editor — available in VS Code, Visual Studio, JetBrains IDEs and Eclipse.