Skip to content

Add SKILL.md for AI assistant integration (Windsurf / Claude Code) - #28

Open
KunihiroS wants to merge 2 commits into
hauntsaninja:mainfrom
KunihiroS:add-skill-md
Open

Add SKILL.md for AI assistant integration (Windsurf / Claude Code)#28
KunihiroS wants to merge 2 commits into
hauntsaninja:mainfrom
KunihiroS:add-skill-md

Conversation

@KunihiroS

Copy link
Copy Markdown

Summary

This PR adds a SKILL.md file that enables AI coding assistants (such as Windsurf and Claude Code) to use git-bayesect as a registered skill.

What is SKILL.md?

SKILL.md is a skill definition file used by AI assistants (Windsurf, Claude Code) to understand:

  • When to suggest using git-bayesect (trigger conditions)
  • How to invoke it via uvx — no pre-installation required
  • The full workflow: start, fail/pass, run, priors, and utility commands

Key design choice: uvx

The skill uses uvx git_bayesect <subcommand> for invocation.
This means users only need uv installed — git-bayesect itself is downloaded and cached automatically on first use.

Who benefits?

Users of AI coding assistants can simply say:

"A flaky test started failing more often around last week. Help me find the commit."

...and the AI will automatically pick up this skill, guide them through the bisection, and run the commands on their behalf.

Notes

  • This file does not affect the tool's functionality in any way
  • It is purely a metadata file for AI tooling
  • Feedback on whether this belongs in the repo is welcome

- 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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread SKILL.md Outdated
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)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge 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 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant