Skip to content

docs: add a contributing guide - #32

Merged
igorjs merged 1 commit into
mainfrom
docs/contributing-and-install
Oct 13, 2026
Merged

igorjs merged 1 commit into
mainfrom
docs/contributing-and-install

Conversation

@igorjs

@igorjs igorjs commented Oct 13, 2026

Copy link
Copy Markdown
Member

Summary

New contributors had no single page to tell them where a change goes or how a release ships. The README also read as if the optional hooks install line works today, and it won't until a playbook release carries the hooks archive.

What Changed

  • Add CONTRIBUTING.md with a table mapping each kind of change (skills and commands, the plugin version, the marketplace listing, authoring guides, model and effort policy) to the file or folder you edit.
  • List the check commands: the Rust prose and structure checks, the marketplace invariants script, and the intents.json check against a playbook binary. It also explains why a skill names an intent in plain words instead of a binary subcommand.
  • Write down the PR rules (title length, signed commits with Signed-off-by, the 1000 line limit, no dashes) and the release steps, from the version bump PR through the signed vX.Y.Z tag and GitHub release.
  • In the README, note the playbook-hooks install line only applies once a playbook release ships the hooks archive.

Signed-off-by: igorjs <2278164+igorjs@users.noreply.github.com>
@igorjs
igorjs marked this pull request as ready for review October 13, 2026 12:14
@igorjs
igorjs added this pull request to the merge queue Oct 13, 2026
Merged via the queue into main with commit b88526e Oct 13, 2026
9 checks passed
@igorjs
igorjs deleted the docs/contributing-and-install branch October 13, 2026 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant