Skip to content

Commit 5e43650

Browse files
blafourcadeclaude
andcommitted
docs: phase 3 medium/low audit fixes (OSS scaffolding, UX, accuracy)
Cherry-picked from 041bdef onto consolidation branch. Resolves the README/CONTRIBUTING conflicts by preserving the slash-commands callout, private-repo caveat, and onboarding hint together. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 95f29c3 commit 5e43650

46 files changed

Lines changed: 324 additions & 37 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Default reviewers for every change in this repository.
2+
# GitHub assigns these reviewers automatically when a pull request is opened.
3+
# See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
4+
* @ai-driven-dev/maintainers

.github/FUNDING.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Funding sources for the AI-Driven Dev framework.
2+
# GitHub Sponsors is not enabled yet; the community website is the canonical channel.
3+
github: []
4+
custom: "https://www.ai-driven-dev.fr/"

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discord community
4+
url: https://discord.gg/ai-driven-dev
5+
about: Ask questions, get help, or chat with the AI-Driven Dev community in real time.
6+
- name: Website
7+
url: https://www.ai-driven-dev.fr/
8+
about: Read the AI-Driven Dev methodology, guides, and announcements.
9+
- name: Report a security vulnerability
10+
url: https://github.com/ai-driven-dev/aidd-framework/security/advisories/new
11+
about: Disclose a vulnerability privately via GitHub Security Advisories. Do not open a public issue.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This repository follows [Semantic Versioning](https://semver.org/) with automate
3535
1. Every push to `main` with conventional commits triggers a **Release PR** (changelog + version bump)
3636
2. When the Release PR is merged → GitHub Release + tag + downloadable tarball
3737

38-
The tarball contains only the framework content: `agents/`, `commands/`, `config/`, `rules/`, `skills/`, `templates/`, `aidd_docs/`, `version.txt`.
38+
The tarball contains only the framework content: `plugins/`, `.claude-plugin/`, `aidd_docs/`.
3939

4040
## Commit scope discipline
4141

README.md

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@
2020

2121
</div>
2222

23-
<!-- TODO: record a 30-60s demo (label an issue, watch a PR open) and embed as docs/demo.gif. LICEcap or QuickTime + ffmpeg work fine. -->
24-
2523
---
2624

2725
## What is AI-Driven Dev?
@@ -43,13 +41,17 @@ Inside any Claude Code session, register this marketplace and install a plugin:
4341
/plugin install aidd-context@aidd-framework
4442
```
4543

44+
> The blocks above are Claude Code slash commands typed inside a Claude Code session, not shell commands.
45+
46+
If the marketplace repo is private, `/plugin marketplace add <owner>/<repo>` requires that you be authenticated with read access to that repo (typically via `gh auth login` or a PAT on the machine running Claude Code). See the Anthropic [Discover and install plugins](https://code.claude.com/docs/en/discover-plugins) docs for the full install flow.
47+
4648
Then run the onboarding skill so the framework guides you from there:
4749

4850
```text
4951
Use skill aidd-context:00:onboard
5052
```
5153

52-
That's it. `aidd-context:00:onboard` inspects your project state, picks the right next skill (init, generate, bootstrap, etc.), and loops back after each step. Install other plugins from the catalog below as your needs grow.
54+
`aidd-context:00:onboard` inspects your project state, picks the right next skill (init, generate, bootstrap, etc.), and loops back after each step. Install other plugins from the catalog below as your needs grow.
5355

5456
Prefer browsing? Run `/plugin` inside Claude Code and open the **Discover** tab once the marketplace is registered.
5557

@@ -59,14 +61,14 @@ Prefer browsing? Run `/plugin` inside Claude Code and open the **Discover** tab
5961

6062
## Plugins
6163

62-
| Plugin | Skills | What it does |
63-
| ------ | ------ | ------------ |
64-
| [aidd-context](plugins/aidd-context/README.md) | 7 | Project init, architecture, context generation, diagrams, learning, discovery |
65-
| [aidd-dev](plugins/aidd-dev/README.md) | 10 | SDLC loop: plan, implement, assert, review, test, refactor, debug |
66-
| [aidd-vcs](plugins/aidd-vcs/README.md) | 4 | Commits, pull/merge requests, release tags, issue creation |
67-
| [aidd-pm](plugins/aidd-pm/README.md) | 4 | Ticket info, user stories, PRD, spec drafting (release candidate) |
68-
| [aidd-orchestrator](plugins/aidd-orchestrator/README.md) | 3 | Orchestration use cases: `async-dev` (label an issue, get a PR) |
69-
| [aidd-refine](plugins/aidd-refine/README.md) | 3 | Meta-cognition: brainstorm, challenge, condense |
64+
| Plugin | Skills | Status | What it does |
65+
| ------ | ------ | ------ | ------------ |
66+
| [aidd-context](plugins/aidd-context/README.md) | 7 | stable | Project init, architecture, context generation, diagrams, learning, discovery |
67+
| [aidd-dev](plugins/aidd-dev/README.md) | 10 | stable | SDLC loop: plan, implement, assert, review, test, refactor, debug |
68+
| [aidd-vcs](plugins/aidd-vcs/README.md) | 4 | stable | Commits, pull/merge requests, release tags, issue creation |
69+
| [aidd-pm](plugins/aidd-pm/README.md) | 4 | release candidate | Ticket info, user stories, PRD, spec drafting |
70+
| [aidd-orchestrator](plugins/aidd-orchestrator/README.md) | 3 | stable (`async-dev`) | Orchestration use cases: `async-dev` (label an issue, get a PR) |
71+
| [aidd-refine](plugins/aidd-refine/README.md) | 3 | stable | Meta-cognition: brainstorm, challenge, condense |
7072

7173
Each plugin's README links to per-skill READMEs covering when to use, how to invoke, prerequisites, and outputs.
7274

@@ -95,6 +97,16 @@ Set scope at install time with the `/plugin` UI, or by editing `enabledPlugins`
9597

9698
---
9799

100+
## Versioning and updates
101+
102+
- Each plugin versions independently via `release-please`. Tags look like `aidd-<plugin>-vX.Y.Z`.
103+
- The root marketplace (`marketplace.json`) versions independently as `vX.Y.Z`.
104+
- Pull updates inside Claude Code with `/plugin marketplace update aidd-framework`.
105+
106+
See [`CHANGELOG.md`](./CHANGELOG.md) for the full history.
107+
108+
---
109+
98110
## Trust and safety
99111

100112
This is a community-maintained marketplace. Plugins can execute commands, edit files, and call external services on your behalf. Before installing any plugin from any third-party marketplace, including this one:
@@ -111,16 +123,19 @@ If you spot a vulnerability, please report it privately via [SECURITY.md](./SECU
111123

112124
| Resource | Where |
113125
| -------- | ----- |
114-
| Methodology, flow guide, conventions | [`aidd_docs/README.md`](aidd_docs/README.md) |
115-
| Skills catalog (auto-generated) | [`aidd_docs/CATALOG.md`](aidd_docs/CATALOG.md) |
126+
| Skills catalog (all plugins) | [`docs/CATALOG.md`](docs/CATALOG.md) |
127+
| Glossary | [`docs/GLOSSARY.md`](docs/GLOSSARY.md) |
116128
| Contribution guide | [`CONTRIBUTING.md`](./CONTRIBUTING.md) |
117129
| Code of Conduct | [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md) |
118130
| Security policy | [`SECURITY.md`](./SECURITY.md) |
119131
| Anthropic plugin docs | [code.claude.com/docs/en/plugins](https://code.claude.com/docs/en/plugins) |
120132

133+
Note: `aidd_docs/` and similar directories generated by `aidd-context:02:project-init` belong to user projects, not to this marketplace. Do not link them from framework-level documentation.
134+
121135
---
122136

123-
## LLM tier reference
137+
<details>
138+
<summary><strong>LLM tier reference</strong> (used by skills that target a specific model tier)</summary>
124139

125140
Some skills target a specific model tier when they need a particular capability. Default tier per task type:
126141

@@ -130,6 +145,8 @@ Some skills target a specific model tier when they need a particular capability.
130145
| **T2** | Balanced | Claude Sonnet, GPT Codex | Implementation, structured analysis, validation, code generation | 8x |
131146
| **T3** | Thinking | Claude Opus, GPT 5.2 | Deep reasoning, synthesis, planning, orchestration, onboarding | 30x |
132147

148+
</details>
149+
133150
---
134151

135152
## Troubleshooting

0 commit comments

Comments
 (0)