Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (40 loc) · 4.27 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 4.27 KB
Raw

Contributing to the AIDD Framework

Source of truth for AIDD skills, agents, rules, and templates — authored in Claude Code syntax; the CLI adapts an archive per tool at release. This file covers contributing to this repository; the wider community, roles, and training programme live at ai-driven-dev.fr.

flowchart LR
    Issue["💡 Issue / idea"] --> Branch["🌿 Branch off next"] --> PR["🔀 Open PR"] --> Review["🛡️ Habilité review"] --> Merge["✅ Squash-merge → next"] --> Release["🚀 Weekly promote → release-please ships"]
Loading

👥 Who can contribute

Roles and their rights are defined in GOVERNANCE.md. Where each starts:

Role Start here
👤 Public Open an issue or discussion
🗳️ Core Team Vote on roadmap priority
🌱 Certifié Open a pull request → Set up
🛡️ Habilité Review and merge

The rest of this guide is the how for those opening PRs.

🔧 1. Set up

Requires Node 22.12+, pnpm, jq, python3, and pipx (gh and the Claude/Codex CLI optional).

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

make lists every target; make doctor and make check verify the environment and run the pre-commit checks (including the Markdown link checker).

✏️ 2. Make your change

  • Test locally — neither tool hot-reloads the checkout (both serve a cached copy). After editing, run make reload (or PLUGIN="aidd-refine aidd-pm" for a subset), then restart the session — /reload-plugins covers a Claude-only edit to an existing skill.
  • Commit — <type>(<scope>): description, one scope per commit (split cross-plugin changes). The types, scopes, and rules live in aidd_docs/memory/vcs.md (mirrors commitlint.config.cjs); the type drives the release → RELEASE.md.

🔀 3. Open a pull request

  • Branch off next, target next — only hotfix/* branches off main for urgent production fixes. The branch prefix alone decides the target → routing table.
  • Fill the PR template — explain what changed and how you solved it; skip re-asserting the conventional title and hooks (CI already enforces them).
  • Label follows your branch kind (the PR skill applies it automatically); add security when relevant.
  • A Habilité review gates every merge (CODEOWNERS) — Certifié contributors cannot self-merge. PRs squash-merge on the conventional title. Decision rules → GOVERNANCE.md.

🚀 Releases

The main/next model, weekly cadence, and hotfix flow → RELEASE.md. A release ships 8 independently-versioned packages (root aidd-framework + the 7 plugins; aidd-ui is alpha) plus per-tool archives; full breakdown → MAINTAINERS.md.

🐛 Reporting issues

Open an issue (🐛 Bug or ✨ Feature) — auto-added to the Roadmap board. For usage questions use Discussions, not issues (see SUPPORT.md).

📚 Reference

  • Build a plugin → docs/CREATE_PLUGIN.md
  • Architecture & terms → docs/ARCHITECTURE.md · docs/GLOSSARY.md
  • Patterns to follow → a minimal plugin aidd-refine, a router skill 00-onboard, agents aidd-dev/agents
  • Per-tool builds → source files use Claude Code syntax; the aidd-cli maps each surface to its per-tool equivalent at release. name / description / argument-hint are universal; other frontmatter keys (model, color, paths, …) are tool-specific and ignored where unsupported.

■ Back to framework