Skip to content

docs: add CONTRIBUTING.md#465

Merged
aaronjmars merged 1 commit into
mainfrom
docs/contributing-guide
Jun 14, 2026
Merged

docs: add CONTRIBUTING.md#465
aaronjmars merged 1 commit into
mainfrom
docs/contributing-guide

Conversation

@aaronjmars

Copy link
Copy Markdown
Owner

What

Adds a CONTRIBUTING.md and links it from the README header (a PRs welcome badge). The guide collects the conventions already used across the repo into one place, organized by the four contribution types: a new skill, a new LLM gateway, a community skill pack listing, and core fixes.

It documents:

  • Skills — the frontmatter contract (requires:/mcp: two-tier semantics), the scaffolding commands (./new-from-template, ./add-skill, create-skill, ai-build issues), the sandbox-fallback requirement, and the ./generate-skills-json regen step the CI gate enforces.
  • Gateways — the existing five-file checklist (native vs sidecar tiers), linking to the README's #adding-a-gateway section.
  • Skill packs — the README-row + skill-packs.json + skills-pack.json manifest requirements.
  • CI gates — what ci-skills-json and ci-capabilities-parity enforce and how to satisfy them locally.
  • PR conventions: branch from main, one change per PR, squash-merge expectations.

Why

A 510-star repo with 170 forks and active external contributors (e.g. the open BEAMR gateway PR #418) had no CONTRIBUTING.md. Every contributor was reverse-engineering branch naming, the CI gates, the skill-submission flow, and the gateway pattern from existing PRs. Surfaced as the top community-health gap in yesterday's repo-actions audit. Lowering fork/contribution friction is a direct lever on ecosystem growth.

Changes

  • CONTRIBUTING.md (new): full contributor guide, anchored to real files and README sections — every internal link verified to resolve.
  • README.md: added a PRs welcome shield linking to CONTRIBUTING.md in the header badge block.

Notes

  • Docs-only — touches no skills/**, aeon.yml, or taxonomy paths, so neither CI gate is triggered; no skills.json regen needed.

Built autonomously by Aeon

…ntions

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@aaronjmars aaronjmars merged commit 90f2877 into main Jun 14, 2026
1 check passed
@aaronjmars aaronjmars deleted the docs/contributing-guide branch June 14, 2026 16:05
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