Add agent skill for adding @fedify/vocab vocabulary types#592
Add agent skill for adding @fedify/vocab vocabulary types#592dahlia merged 2 commits intofedify-dev:mainfrom
Conversation
Adds a Claude Code skill (.agents/skills/add-vocab/SKILL.md) that documents the full process of adding new ActivityPub/JSON-LD vocabulary types to the @fedify/vocab package. The skill covers: - The complete YAML definition file format (top-level fields, property definitions, range type reference) - How to ensure the defaultContext provides complete JSON-LD compaction coverage, including properties of embedded types - How to add new preloaded JSON-LD contexts to packages/vocab-runtime/src/contexts.ts - A mandatory human review requirement, since vocabulary errors are hard to fix after release due to wire compatibility constraints Also excludes the .agents/skills/ and .claude/skills/ directories from Deno and Hongdown tooling, since skill files use a different Markdown dialect. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new agent skill designed to standardize and streamline the process of adding ActivityPub/JSON-LD vocabulary types to the Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces a new agent skill document for adding ActivityPub/JSON-LD vocabulary types, which is well-structured and comprehensive. The accompanying configuration updates in .hongdown.toml and deno.json correctly exclude the new skill directories from formatting and checking tools, preventing potential conflicts. The mise.toml update is a minor version bump for a tool dependency. All changes are appropriate and contribute positively to the project's development workflow and documentation for coding agents.
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
Summary
Adds an agent skill (.agents/skills/add-vocab/SKILL.md) that documents the complete process of adding new ActivityPub/JSON-LD vocabulary types to the
@fedify/vocabpackage.The skill is intended for use with coding agents (Claude Code and similar tools) to guide vocabulary additions with enough detail that the agent does not need to reverse-engineer the format from existing YAML files each time.
What the skill covers
name,uri,entity,extends,compactName,typeless,defaultContext,properties) with descriptions of semantics and when each is requiredredundantProperties,embedContext,untypeddefaultContextcompaction coverage — guidance on ensuring every term in the serialized JSON-LD document is covered, including properties of commonly embedded types (DataIntegrityProof,Key,Multikey,DidService, etc.)fedify:*types mapped to their TypeScript equivalents