mirror of https://github.com/kunchenguid/gh-axi.git synced 2026-09-19 00:53:51 +08:00

Files

T

Kun Chen 70fea53e39 fix: keep the installable skill as a CLI-deferring stub (#118 )

* fix: keep the installable skill a CLI-deferring stub

Installed copies of SKILL.md go stale when gh-axi's help changes. Generate
only identity, when-to-use, and pointers at the live CLI so regeneration
cannot re-inflate command, flag, or workflow instructions.

Co-authored-by: Cursor <cursoragent@cursor.com>

* no-mistakes(document): Refresh minimal skill documentation

---------

Co-authored-by: Cursor <cursoragent@cursor.com>

2026-08-23 16:57:08 -07:00

2.7 KiB

Raw Permalink Blame History

Contributing

Thanks for wanting to contribute. One rule up front:

Human-authored pull requests targeting main must be raised through no-mistakes. We require this to reduce the maintainer's burden of reviewing and merging contributions.

no-mistakes puts a local git proxy in front of your real remote. Pushing through it runs an AI-driven review/test/lint pipeline in an isolated worktree, forwards the push upstream only after every check passes, and opens a clean PR automatically.

A GitHub Actions check (Require no-mistakes) runs on PRs targeting main and fails if the body is missing the deterministic signature and pipeline attestation that no-mistakes writes. The attestation must describe the PR's current head and record the review, test, and document steps as completed. The release and dependency bots are exempt so their automation keeps working, but regular contributor PRs without the signature will not be reviewed or merged.

Workflow

Fork the repo, then clone the parent repo or set your local origin back to the parent repo (git@github.com:kunchenguid/gh-axi.git).
Create a branch and make your changes.
Initialize or refresh the gate with your fork as the push target: no-mistakes init --fork-url git@github.com:<you>/gh-axi.git.
Commit your changes.
Push through the gate instead of pushing to origin:
```
git push no-mistakes
```
Run no-mistakes to attach to the pipeline, watch findings, and auto-fix or review as needed.
Once the pipeline passes, it pushes the branch to your fork and opens the PR against this repo for you.

The required pipeline attestation and fork routing require no-mistakes v1.46.0 or newer. Run no-mistakes update before git push no-mistakes if your installed version is older.

See the no-mistakes quick start for the full first-run walkthrough.

Repo conventions

Node 20+, TypeScript, ESM-only.
Install dependencies with pnpm install --frozen-lockfile; run pnpm run build and pnpm test before pushing.
After changing dependencies, run pnpm exec prettier --write pnpm-lock.yaml so the committed lockfile keeps its Prettier formatting.
Do not hand-edit CHANGELOG.md or .release-please-manifest.json. They are regenerated by release-please from your conventional commit messages.
Do not bump package.json's version by hand for ordinary changes. release-please updates it in the release PR.
Do not hand-edit skills/gh-axi/SKILL.md. It is generated from src/skill.ts, including frontmatter metadata; run pnpm run build:skill and commit the result.

Questions

Open an issue, or talk to me on Discord.

2.7 KiB Raw Permalink Blame History

Contributing

Workflow

Repo conventions

Questions

2.7 KiB

Raw Permalink Blame History