-
Notifications
You must be signed in to change notification settings - Fork 374
[codex] Document Conductor command wrapper #739
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -6,6 +6,55 @@ React on Rails demo app — a Rails application with React, Redux, Tailwind CSS, | |||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `prompts/`: shared prompt templates for Codex, GPT, and other non-Claude tools | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Build and Test Commands | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Run development server | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| bin/dev | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Run tests | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| bundle exec rspec | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
The new build/test quick-reference shows running Useful? React with 👍 / 👎. |
||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Run linting | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| bundle exec rubocop | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Auto-fix linting issues | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| bundle exec rubocop -a | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The commands here are shown without Consider adding a note, e.g.:
Or restructure so the wrapper examples in the Conductor section cover
Comment on lines
+11
to
+23
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Working Rules | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| - When the user asks to address PR review comments, follow `prompts/address-review.md`. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Run Ruby, Bundler, Node, pnpm, and git hook-sensitive commands through `bin/conductor-exec` so non-interactive shells use the project tool versions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "non-interactive shells" is generic — the section below clarifies this is specifically a Conductor issue. Tying the rule to Conductor here makes the bullet self-contained and matches the section heading just below.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| ## Conductor Compatibility | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| Conductor runs commands in a non-interactive shell that does not source `.zshrc`. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| That means version manager shell hooks, such as mise PATH reordering from `.tool-versions`, | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| may not run. Commands can accidentally use system Ruby or Node instead of the project versions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| Symptoms include: | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `ruby --version` returns system Ruby instead of the project Ruby. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Pre-commit hooks fail with the wrong tool versions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| - `bundle` commands fail due to incompatible Ruby versions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| - Node or pnpm commands use the wrong Node version. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| Use the wrapper for commands that depend on project tool versions: | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Instead of: | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ruby --version | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| bundle exec rubocop | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| pnpm install | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| git commit -m "message" | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| # Use: | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| bin/conductor-exec ruby --version | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| bin/conductor-exec bundle exec rubocop | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| bin/conductor-exec pnpm install | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| bin/conductor-exec git commit -m "message" | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Worth adding the same inline comment that
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| The wrapper uses `mise exec` when mise is available and falls back to direct execution | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The fallback is
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| for non-mise users. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The commands shown here (e.g.
bundle exec rspec) are the bare forms, but the Conductor Compatibility section added below recommends wrapping them all withbin/conductor-exec. An agent reading sequentially could run these bare commands before reaching that guidance.Consider adding a brief callout here, e.g.:
Or alternatively, show the wrapped forms here and drop the duplication in the Conductor section.