Skip to content

Commit 6c60270

Browse files
authored
Document bundled skill installation across agent tools (#3)
* Document Codex skill installation * Expand agent skill install options * Document branch protection governance
1 parent dd25810 commit 6c60270

5 files changed

Lines changed: 103 additions & 1 deletion

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@
1313

1414
- Keep the PR focused.
1515
- Call out any follow-up work explicitly instead of bundling it into this change.
16+
- Do not relax branch protection, required reviews, or required CI checks to merge this PR. Governance changes should be handled separately from feature or docs changes.

AGENTS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Agent Instructions
2+
3+
This repository is maintained under strict branch protection. Treat those protections as part of the repository policy, not as temporary friction to work around.
4+
5+
## Branch Protection Policy
6+
7+
- Never change branch protection rules, rulesets, required reviews, required status checks, or admin enforcement in order to land a change unless the user explicitly asks for that exact repository-governance change.
8+
- Never disable `CODEOWNERS` review requirements, required approving review counts, required conversation resolution, or required CI checks just to merge a PR.
9+
- Never push directly to a protected branch to bypass the normal review or CI path.
10+
- Never use admin merge, force push, or equivalent bypass mechanisms to land a change unless the user explicitly asks for that governance exception.
11+
- If branch protection blocks a merge, stop and tell the user what requirement is still unmet.
12+
13+
## Preferred Flow
14+
15+
1. Make the change on a feature branch.
16+
2. Open a PR.
17+
3. Let required CI checks complete.
18+
4. Wait for the required review state.
19+
5. Merge only through the normal repository policy path.
20+
21+
## If Blocked
22+
23+
- Report the exact protection rule that is blocking progress.
24+
- Ask the user whether they want to satisfy the rule or intentionally change repository governance.
25+
- Treat repository-governance changes as a separate task from the feature or docs change that triggered the block.

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Thanks for contributing to `react-devtool-cli`.
3232
- Add or update tests when behavior changes.
3333
- Preserve the CLI's bias toward deterministic, structured output.
3434
- Do not bundle unrelated refactors into the same PR.
35+
- Do not weaken branch protection, bypass required reviews, or disable required CI checks to land a change. If protection blocks a merge, satisfy the rule or ask the maintainer whether repository governance should change as a separate decision.
3536

3637
## Development
3738

README.md

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,70 @@ This follows the same overall shape as Playwright's own CLI surface: one command
1919
npm install -g react-devtool-cli
2020
```
2121

22+
## Install the bundled agent skill
23+
24+
If you want an AI coding agent to know how to operate the published `rdt` CLI, install the bundled `react-devtool-cli` skill with the method that matches your toolchain.
25+
26+
### Codex
27+
28+
Copy `skills/react-devtool-cli` into `$CODEX_HOME/skills` (`~/.codex/skills` by default), then restart Codex.
29+
30+
macOS/Linux:
31+
32+
```bash
33+
git clone https://github.com/Ring-wdr/react-devtool-cli.git
34+
mkdir -p ~/.codex/skills
35+
cp -R react-devtool-cli/skills/react-devtool-cli ~/.codex/skills/react-devtool-cli
36+
```
37+
38+
Windows PowerShell:
39+
40+
```powershell
41+
git clone https://github.com/Ring-wdr/react-devtool-cli.git
42+
New-Item -ItemType Directory -Force "$env:USERPROFILE/.codex/skills" | Out-Null
43+
Copy-Item -Recurse -Force ".\\react-devtool-cli\\skills\\react-devtool-cli" "$env:USERPROFILE/.codex/skills/react-devtool-cli"
44+
```
45+
46+
### Claude Code
47+
48+
Claude Code discovers skills from `~/.claude/skills/<skill-name>/SKILL.md` for personal skills and `.claude/skills/<skill-name>/SKILL.md` for project-scoped skills. Copy this repository's bundled skill directory into one of those locations:
49+
50+
```bash
51+
git clone https://github.com/Ring-wdr/react-devtool-cli.git
52+
mkdir -p ~/.claude/skills
53+
cp -R react-devtool-cli/skills/react-devtool-cli ~/.claude/skills/react-devtool-cli
54+
```
55+
56+
For project-only usage, copy it to `.claude/skills/react-devtool-cli` inside your repo instead.
57+
58+
### Gemini CLI
59+
60+
Gemini CLI has built-in skill management. Install directly from this repo:
61+
62+
```bash
63+
gemini skills install https://github.com/Ring-wdr/react-devtool-cli.git --path skills/react-devtool-cli
64+
```
65+
66+
If you already cloned this repository locally, you can also link the whole skills folder and let Gemini discover it:
67+
68+
```bash
69+
gemini skills link /path/to/react-devtool-cli/skills --scope workspace
70+
```
71+
72+
Reload discovered skills with `/skills reload` if the current session is already open.
73+
74+
### skills.sh
75+
76+
If you want one installer path that configures the skill for a supported agent automatically, use `skills.sh`:
77+
78+
```bash
79+
npx skills add https://github.com/Ring-wdr/react-devtool-cli --skill react-devtool-cli
80+
```
81+
82+
This is the easiest cross-tool path when you are using ecosystems such as Claude Code, Gemini CLI, Codex, or Antigravity.
83+
84+
If you are working on the repository itself rather than using the published CLI, install `skills/react-devtool-cli-repo` with the same tool-specific pattern.
85+
2286
Published package notes:
2387

2488
- npm consumers receive built files from `dist/`, not the repository source tree.
@@ -251,9 +315,13 @@ Use `node pick` when the agent knows the visible element but not the component n
251315

252316
## Skills
253317

254-
- Installed CLI user skill: [skills/react-devtool-cli/SKILL.md](./skills/react-devtool-cli/SKILL.md)
318+
Bundled skill directories in this repository:
319+
320+
- CLI user skill: [skills/react-devtool-cli/SKILL.md](./skills/react-devtool-cli/SKILL.md)
255321
- Repository maintenance skill: [skills/react-devtool-cli-repo/SKILL.md](./skills/react-devtool-cli-repo/SKILL.md)
256322

323+
Use the installation routes above to place either skill into your agent's skill directory or installer flow.
324+
257325
## Notes
258326

259327
- Initial browser support is Chromium-only

docs/public-repo-strategy.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,10 @@ This repository is run as a solo-maintainer open source project. The operating m
5151
- Discussions disabled unless issue volume justifies a separate support channel
5252
- Secret scanning enabled when available
5353
- Topic metadata kept current so the repo is discoverable without overselling scope
54+
55+
## 8. Governance Guardrails
56+
57+
- Branch protection is part of the maintenance policy, not a convenience setting.
58+
- Do not reduce required reviews, required checks, or code owner enforcement just to land an otherwise-ready PR.
59+
- Do not use admin overrides for normal day-to-day maintenance.
60+
- If a branch protection rule becomes counterproductive, change that governance intentionally in a separate maintainer decision, not as part of shipping an unrelated fix.

0 commit comments

Comments
 (0)