Skip to content

Commit d52c3cc

Browse files
Merge pull request #1024 from CommandCodeAI/docs/reviewed-mods-registry
docs: describe reviewed npm and GitHub mod listings
2 parents 0756a47 + 9a87ebd commit d52c3cc

2 files changed

Lines changed: 14 additions & 6 deletions

File tree

‎mods/README.md‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
[mods hub](https://commandcode.ai/mods). The hub reads it live, so a merged PR here lists
55
your mod within minutes — no website deploy.
66

7-
Two ways a mod gets listed:
8-
9-
1. **Publish to npm with the `cmd-mod` keyword** — it is discovered automatically, no PR needed.
10-
2. **Open a PR against `registry.json`** — for git-only mods, or to add richer metadata. This is that path.
7+
Every listed mod has a reviewed entry in `registry.json`. Publish your mod to npm
8+
or GitHub, then open a PR against this file. Publishing an npm package with the
9+
`cmd-mod` keyword helps maintainers discover it for review; it does not list it
10+
automatically. Existing GitHub entries continue to load from the file without
11+
an npm review or a website deployment.
1112

1213
## Add your mod
1314

@@ -37,10 +38,17 @@ against [`registry.schema.json`](./registry.schema.json).
3738
| `author` | yes | `{ "name": "…" }` required; optional `github` / `url` link the name |
3839
| `kinds` | yes | one or more of `tool` `command` `hook` `provider` `renderer` `flag` |
3940
| `repo` | no | a GitHub URL also enables the star count |
40-
| `npm` | no | links the entry to its npm package for live download counts |
41+
| `npm` | no | names its published npm package for live metadata and download counts |
4142
| `tags` | no | lowercase slugs, searchable |
4243
| `addedAt` | no | `YYYY-MM-DD`, used for the "Newest" sort |
4344

4445
`official`, `featured`, and the top-level `hidden` list are maintainer-only — leave them out of your PR.
4546

4647
Keep the array valid JSON (no trailing commas) and one mod per PR where you can, so review stays quick.
48+
49+
For an npm mod, set both `source` and `npm` to the full package name, including
50+
its scope. Give scoped packages a separate unique lowercase `name` matching the
51+
schema. The entry supplies the description, author, categories, and tags; npm
52+
adds the latest version, publish date, and monthly downloads. A GitHub `repo`
53+
adds its star count. Maintainers review the published package code before
54+
listing it. Review is not a sandbox or a guarantee about future releases.

‎mods/registry.schema.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"$schema": "http://json-schema.org/draft-07/schema#",
33
"title": "Command Code mods registry",
4-
"description": "The curated layer behind commandcode.ai/mods. Packages published to npm with the `cmd-mod` keyword are listed automatically; this file adds git-only mods, richer metadata over npm entries (matched by `npm`), and the `hidden` list for moderation. The resolved list is served at https://commandcode.ai/mods.json.",
4+
"description": "The reviewed list behind commandcode.ai/mods. Each npm or GitHub mod requires a registry entry; publishing to npm alone does not list a package. The `npm` field enables live metadata and downloads, and `hidden` excludes entries for moderation. The resolved list is served at https://commandcode.ai/mods.json.",
55
"type": "object",
66
"required": ["version", "mods"],
77
"properties": {

0 commit comments

Comments
 (0)