diff --git a/.github/AGENTS.md b/.github/AGENTS.md deleted file mode 100644 index d468b04..0000000 --- a/.github/AGENTS.md +++ /dev/null @@ -1,8 +0,0 @@ -# GitHub workflow guidance - -- Keep untrusted pull-request workflows isolated in `*-public-unmerged.yml` on - pinned GitHub-hosted runners with read-only permissions and no secrets. -- Trusted default-branch automation must use pinned actions, least privilege, - bounded concurrency, measured job timeouts, and credential-free checkout. -- Install project tooling through mise. Never use Homebrew in this repository. -- Keep `ubuntu-26.04` explicit; never use floating runner labels. diff --git a/AGENTS.md b/AGENTS.md index c5235fd..4cf906f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,59 +1,10 @@ -# AGENTS.md +# Rules -A plugin providing development workflow skills for the [jackin](https://github.com/jackin-project/jackin) project. +- No legacy code. Finish every migration: remove old paths completely—no compatibility shims, aliases, or deprecation periods. Breaking changes are preferred. +- This is a research project. It is unsafe and expected to contain breaking changes; never treat it as production-ready. Break things when needed and deliver new implementations fast. +- Always apply these principles: + - Judge work by correctness, consistency, and project fit. Never defer a known-wrong state because of ROI, cost, effort, or claims that it is low-value, marginal, or an edge case. + - Stop only when the required change is proven impossible with the available tools or model. When uncertain, inspect, test, and measure first. + - Before fixing a bug, identify why the architecture permitted it and whether the same structure permits related bugs. + - Prefer fixes that remove the enabling condition. Use a symptom-layer patch only when the root fix is proven infeasible or belongs in a separate change, and name the deferred root cause. -One `skills//SKILL.md` source serves every supported native plugin and -Amp's native Claude-plugin compatibility bridge. -Installation, the per-client compatibility matrix, and duplicate-avoidance -rules live in `INSTALL.md`. Never install jackin skills into shared global skill -directories; native plugins are the only supported distribution profile. - -All skills are **manual-only**. Claude Code, Grok, and Kimi honor -`disable-model-invocation: true`; Codex uses `agents/openai.yaml` with -`policy.allow_implicit_invocation: false`. Every description begins with an -explicit-request guard for clients that ignore those policy fields. - -## Skills - -Eleven skills live under `skills/`: `jackin-propose`, `jackin-brainstorm`, `jackin-research`, `jackin-create-pr`, `jackin-refresh-pr`, `jackin-checkout-pr`, `jackin-goal-prompt`, `jackin-merge-pr` (feature workflow) and `jackin-release-check`, `jackin-release-notes`, `jackin-release`. All manual-only. - -- **What each does, the workflow model, and the design** — see [README.md](README.md). -- **The full process for one skill** — see its `skills//SKILL.md`. - -Invoke by skill name `jackin-` using the native plugin syntax documented -in `INSTALL.md`. - -## Requirements - -- The target repository must have `cargo-release` configured with `release.toml` -- The target repository must have a `CHANGELOG.md` with `` marker -- The `gh` CLI must be authenticated -- A `.github/workflows/ci.yml` workflow must exist for CI status checks - -## Commit Messages - -All commits in this repository MUST follow [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). - -Subject format: `[optional scope][!]: ` - -Allowed types: - -| Type | Use for | -| ---------- | ------------------------------------------------------ | -| `feat` | New user-visible feature | -| `fix` | Bug fix | -| `docs` | Documentation-only change | -| `style` | Formatting, whitespace; no logic change | -| `refactor` | Internal restructuring; no behavior change | -| `perf` | Performance improvement | -| `test` | Adding or updating tests | -| `build` | Build system, tooling, dependencies | -| `ci` | CI configuration | -| `chore` | Routine maintenance (release, merge, deps) | -| `revert` | Reverts a prior commit | - -Scope is optional but encouraged when it clarifies the change area. - -Breaking changes use `!` after the type/scope (`feat!:` or `feat(api)!:`) and include a `BREAKING CHANGE:` footer in the body. - -PR squash-merge: the PR title becomes the commit subject, so PR titles must also follow this convention. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 0000000..47dc3e3 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file