Skip to content

Commit 3f20c74

Browse files
xuiocodex
andcommitted
Improve repository onboarding
Refresh the README, add focused usage/development/architecture/troubleshooting docs, add GitHub issue and PR templates, and track wiki source pages for the enabled repository wiki. Co-Authored-By: OpenAI Codex <noreply@openai.com>
1 parent 84d8f90 commit 3f20c74

17 files changed

Lines changed: 1053 additions & 172 deletions
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Bug report
2+
description: Report a reproducible problem with the Claude Code Codex Subagents plugin.
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting a problem. Please avoid pasting secrets, auth logs, private prompts, or raw MCP traffic that contains sensitive project data.
10+
- type: textarea
11+
id: summary
12+
attributes:
13+
label: Summary
14+
description: What happened, and what did you expect instead?
15+
placeholder: Claude called the plugin, but...
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: reproduce
20+
attributes:
21+
label: Reproduction steps
22+
description: Include the smallest prompt/tool call that reproduces the issue.
23+
placeholder: |
24+
1. Start Claude Code with ...
25+
2. Ask Claude ...
26+
3. Observe ...
27+
validations:
28+
required: true
29+
- type: input
30+
id: plugin-version
31+
attributes:
32+
label: Plugin version or commit
33+
placeholder: 0.1.1 or git SHA
34+
- type: input
35+
id: claude-version
36+
attributes:
37+
label: Claude Code version
38+
placeholder: claude --version
39+
- type: input
40+
id: codex-version
41+
attributes:
42+
label: Codex version
43+
placeholder: codex --version
44+
- type: dropdown
45+
id: path
46+
attributes:
47+
label: Execution path
48+
options:
49+
- ask_codex
50+
- ask_codex_parallel
51+
- persistent session
52+
- async job
53+
- app-server steering
54+
- plugin install/loading
55+
- other
56+
- type: textarea
57+
id: diagnostics
58+
attributes:
59+
label: Diagnostics
60+
description: Paste sanitized `codex_status`, `codex_doctor`, or debug bundle excerpts. Redact private data.
61+
render: text

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Security vulnerability
4+
url: https://github.com/xuio/claude-code-codex-subagents/security/advisories/new
5+
about: Report private security issues through GitHub Security Advisories.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Feature request
2+
description: Suggest an improvement to Codex delegation from Claude Code.
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: Problem
10+
description: What workflow should become easier or more reliable?
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: proposal
15+
attributes:
16+
label: Proposal
17+
description: What should the plugin do?
18+
validations:
19+
required: true
20+
- type: dropdown
21+
id: area
22+
attributes:
23+
label: Area
24+
options:
25+
- Claude tool selection
26+
- Codex sessions
27+
- Parallel agents
28+
- Nested subagents
29+
- Logging or diagnostics
30+
- Installation
31+
- Testing
32+
- Documentation
33+
- Other
34+
- type: textarea
35+
id: constraints
36+
attributes:
37+
label: Constraints
38+
description: Security, compatibility, performance, or UX constraints to preserve.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Summary
2+
3+
-
4+
5+
## Validation
6+
7+
- [ ] `npm run test:ci`
8+
- [ ] `npm run check:dist`
9+
- [ ] Real Claude/Codex validation, if the change affects live integration
10+
11+
## Safety
12+
13+
- [ ] Default behavior remains read-only unless this PR intentionally changes it
14+
- [ ] No credentials, private logs, local auth data, or machine-specific artifacts are committed
15+
- [ ] `dist/index.js` is rebuilt when TypeScript source changes

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Changelog
22

3+
## Unreleased
4+
5+
- Refreshed the README into a shorter onboarding page.
6+
- Added usage, architecture, development, and troubleshooting docs.
7+
- Added GitHub issue templates and a pull request template.
8+
39
## 0.1.1
410

511
- Compacted large MCP tool responses so successful long Codex runs do not surface as Claude Code tool-result overflow errors.

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ npm run test:ci
1313

1414
`test:ci` is the portable suite used by GitHub Actions. It uses the fake Codex binary and does not require Claude Code, the Codex desktop app, or live credentials.
1515

16+
See [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) for the full local setup, dev-link workflow, test tiers, and release checklist.
17+
1618
Desktop-only and live-token checks are available when you need end-to-end validation:
1719

1820
```sh
@@ -27,3 +29,5 @@ npm run test:claude-real-codex
2729
- Prefer small, focused changes with tests that cover the MCP contract.
2830
- Do not commit credentials, local logs, generated temp files, or machine-specific paths.
2931
- Run `npm run build` before committing changes to `src/`, because the plugin manifest loads `dist/index.js`.
32+
- Run `npm run check:dist` before publishing changes that touch TypeScript source.
33+
- Update user-facing docs when tool names, defaults, safety behavior, or validation commands change.

0 commit comments

Comments
 (0)