Skip to content

Commit f1c00f2

Browse files
authored
Merge pull request #947 from dahlia/docs/contributing.md
Unify contributor and agent guidance [ci skip]
2 parents 2d46cdb + 01f773f commit f1c00f2

6 files changed

Lines changed: 484 additions & 967 deletions

File tree

‎.agents/skills/add-vocab/SKILL.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ description: >-
77
implementing FEPs, extending ActivityStreams vocabulary, or adding third-party
88
vocab types such as Mastodon extensions, Litepub types, or other fediverse
99
vocabularies.
10-
version: 1.0.0
1110
---
1211

1312
Adding vocabulary to @fedify/vocab
@@ -52,12 +51,17 @@ Workflow
5251
5. If a new context URL is needed, add it to
5352
`packages/vocab-runtime/src/contexts.ts`
5453
6. Run `mise run codegen` to generate TypeScript classes
55-
7. Run `mise run check` to verify everything compiles
56-
8. Ask the user to review the YAML definition and generated code carefully
54+
7. Run `mise run test:update_snapshots` to update the Deno, Node.js, and Bun
55+
snapshots
56+
8. Run `mise run check` to verify everything compiles
57+
9. Ask the user to review the YAML definition and generated code carefully
5758
before committing
5859

5960
The generated TypeScript class is automatically exported from `@fedify/vocab`
6061
via `packages/vocab/src/vocab.ts` (generated) and `packages/vocab/src/mod.ts`.
62+
The `@fedify/vocab-tools` snapshots are stored separately for Deno, Node.js,
63+
and Bun. Always update all three with the aggregate task when generated output
64+
changes; do not update only one runtime's snapshot.
6165

6266

6367
YAML file format

‎.hongdown.toml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
no_inherit = true
22
include = ["*.md", "**/*.md"]
33
exclude = [
4+
".git/**",
45
"**/node_modules/**",
56
"**/dist/**",
67
".agents/skills/**",
78
".claude/skills/**",
89
".github/copilot-instructions.md",
9-
"AGENT.md",
10+
"AGENTS.md",
1011
"CLAUDE.md",
1112
"GEMINI.md",
1213
"WARP.md",

0 commit comments

Comments
 (0)