Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (38 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

52 lines (38 loc) · 3.01 KB
Raw

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 that no-mistakes writes. 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

  1. Fork the repo, then clone the parent repo or set your local origin back to the parent repo (git@github.com:kunchenguid/quota-axi.git).

  2. Create a branch and make your changes.

  3. Initialize or refresh the gate with your fork as the push target: no-mistakes init --fork-url git@github.com:<you>/quota-axi.git.

  4. Commit your changes.

  5. Push through the gate instead of pushing to origin:

    git push no-mistakes

  6. Run no-mistakes to attach to the pipeline, watch findings, and auto-fix or review as needed.

  7. Once the pipeline passes, it pushes the branch to your fork and opens the PR against this repo for you.

Fork routing requires no-mistakes v1.30.1 or newer.

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, pnpm run lint, pnpm run format:check, pnpm test, and pnpm run build:skill -- --check before pushing.
  • Run pnpm run format when pnpm run format:check reports formatting drift.
  • 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 change release-please-config.json's bootstrap-sha for ordinary changes. It points at commit 9f5dc949c50ab8ac0a441be777e1c3693ee0b612, the published npm 0.1.0 baseline.
  • Do not hand-edit skills/quota-axi/SKILL.md. It is generated from the shared skill source, including frontmatter metadata; run pnpm run build:skill and commit the result.
  • quota-axi is data only: it must never route, recommend, proxy, intercept, log in, import browser cookies, or mutate provider state. Keep changes within that boundary.

Questions

Open an issue, or talk to me on Discord.