Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (44 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 2.98 KB
Raw

Contributing to the AIDD Framework

👥 How to contribute

One path, open to everyone (roles).

flowchart LR
    Start(["Something to share?"]) -->|"just a question"| Discussion["💬 Discussions"]
    Start --> Bug["🐛 Bug"]
    Start --> Quick["🌱 Quick<br/>problem + solution"]
    Start --> Detailed["📋 Detailed<br/>scope + acceptance criteria"]
    Bug --> Validate["✅ Get validated"]
    Quick --> Validate
    Detailed --> Validate
    Validate --> Setup["🔧 Set up"] --> Changes["✏️ Changes"] --> PR["🔀 Open PR"] --> Review["🛡️ Review"] --> Merge["✅ Merged"]
Loading
  1. Just a question? → Discussions.
  2. Open an issue — 🐛 Bug Report, 🌱 Quick Contribution, or 📋 Detailed Contribution.
  3. Get it validated — a Certified Member or Maintainer moves it to Todo. Green light.
  4. Want to build it yourself? → Set up. Anyone can pick up a validated issue, not just the person who opened it.
  5. Open your PR → Open a pull request.

📜 Principles

What holds for every contribution, whatever you're building:

  • No slop — read every line before proposing it.
  • Spend tokens like they cost something.
  • Claude Code syntax only — skills, agents, and rules are authored in Claude Code syntax (the CLI adapts a per-tool archive at release).
  • Follow the skill structure → ARCHITECTURE.md, use the /aidd-context:04-skill-generate.
  • Evolve the memory → aidd_docs/memory/.

🔧 Set up

Requires Node 22.12+, pnpm, jq, python3, pipx.

make setup   # deps, git hooks, registers the marketplace, installs plugins into Claude + Codex

make lists every target; make doctor checks your environment, make check runs the pre-commit checks.

✏️ Make your change

  • Follow the Principles.
  • Test locally — run make reload, restart your session(s). Test in Claude and one other tool (e.g. Codex).
  • Commit — <type>(<scope>): description, one scope per commit → convention.

🔀 Open a pull request

📚 Reference

ARCHITECTURE.md · CREATE_PLUGIN.md · GLOSSARY.md

■ Back to framework