Add SKILL.md for AI assistant integration (Windsurf / Claude Code) - #28
Add SKILL.md for AI assistant integration (Windsurf / Claude Code)#28KunihiroS wants to merge 2 commits into
Conversation
- Introduce `git-bayesect`, a Bayesian git bisect tool for flaky test failure rate regression identification - Explain use cases, prerequisites, and invocation via uvx - Detail basic workflow: start, record observations, automated run, and status check - Describe setting priors from filenames, commit text, or manually - Document utility commands: undo, log, reset, checkout - Clarify key concepts and example convergence output - Provide typical usage pattern and AI guidance notes for users
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3f64d0f7c8
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| cd <your-git-repo> | ||
|
|
||
| # Start bisection from 2 commits back and run automatically | ||
| OLD_COMMIT=$(git rev-list HEAD --reverse | head -n 2 | tail -n 1) |
There was a problem hiding this comment.
Select old commit relative to HEAD
This example computes OLD_COMMIT as the second commit in the entire repository history, not “2 commits back” from the current tip. In repos with long histories, that dramatically widens the bisect window and can make run take far more observations than intended (or become impractical), so users following the skill will get much slower and potentially confusing results. Use a revision relative to HEAD (for example HEAD~2) if the intent is truly “2 commits back.”
Useful? React with 👍 / 👎.
Summary
This PR adds a
SKILL.mdfile that enables AI coding assistants (such as Windsurf and Claude Code) to usegit-bayesectas a registered skill.What is SKILL.md?
SKILL.mdis a skill definition file used by AI assistants (Windsurf, Claude Code) to understand:git-bayesect(trigger conditions)uvx— no pre-installation requiredstart,fail/pass,run, priors, and utility commandsKey design choice: uvx
The skill uses
uvx git_bayesect <subcommand>for invocation.This means users only need
uvinstalled —git-bayesectitself is downloaded and cached automatically on first use.Who benefits?
Users of AI coding assistants can simply say:
...and the AI will automatically pick up this skill, guide them through the bisection, and run the commands on their behalf.
Notes