From f271f003d4eb7d1d796e6d2617b320295b6da3fe Mon Sep 17 00:00:00 2001 From: "Jason (Json)" <263060202+fuller-stack-dev@users.noreply.github.com> Date: Mon, 25 May 2026 10:19:40 -0600 Subject: [PATCH] docs: require maintainer-editable PR branches Require contributor and agent-created PR branches to stay maintainer-editable, with a GitHub Actions/secrets caveat for fork PRs. Verification: - pnpm docs:list - git diff --check - Real behavior proof: https://github.com/openclaw/openclaw/actions/runs/26409882732/job/77741796262 - check-docs: https://github.com/openclaw/openclaw/actions/runs/26409857961/job/77741751070 Changelog intentionally skipped per maintainer request. Co-authored-by: FullerStackDev <263060202+fuller-stack-dev@users.noreply.github.com> --- AGENTS.md | 1 + CONTRIBUTING.md | 1 + 2 files changed, 2 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 141cb9484701..c81a3f73b243 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -126,6 +126,7 @@ Skills own workflows; root owns hard policy and routing. - `ship` that fixes an issue: after push, comment proof + commit link, then close the issue. - GH comments with backticks, `$`, or shell snippets: use heredoc/body file, not inline double-quoted `--body`. - PR create: real body required. Include Summary + Verification; mention refs, behavior, and proof. +- PR create/refresh: keep PR branches takeover-ready. Use a branch maintainers can push to, or for fork PRs ensure `maintainer_can_modify` / GitHub's `Allow edits by maintainers` is enabled unless explicitly told otherwise or GitHub's Actions/secrets warning makes that unsafe. - GitHub issue/PR create: read `$agent-transcript`; ask about sanitized transcript logs when available. - Real behavior proof section is parsed. Use exact `field: value` labels: `Behavior addressed`, `Real environment tested`, `Exact steps or command run after this patch`, `Evidence after fix`, `Observed result after fix`, `What was not tested`. - PR artifacts/screenshots: attach to PR/comment/external artifact store. Do not commit `.github/pr-assets`. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a52186bfb806..28a5ca8a7a38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -107,6 +107,7 @@ For coordinated change sets that genuinely need more than 20 PRs, join the **#cl - Test locally with your OpenClaw instance - External PRs must include a filled **Real behavior proof** section in the PR body. Show the real setup you tested, the exact command or steps you ran after the patch, after-fix evidence, the observed result, and anything you did not test. Screenshots, recordings, terminal screenshots, console output, copied live output, linked artifacts, and redacted runtime logs all count. Unit tests, mocks, snapshots, lint, typechecks, and CI are useful but do not satisfy this requirement by themselves. Maintainers may apply `proof: override` only when the proof gate should not apply. +- Keep PRs takeover-ready: open them from a branch maintainers can push to. For fork PRs, leave GitHub's **Allow edits by maintainers** option enabled so maintainers can finish urgent fixes, changelog entries, or merge prep when needed. If GitHub shows **Allow edits and access to secrets by maintainers**, enable it only when that workflow/secrets access is acceptable and say so in the PR. - Do not edit `CHANGELOG.md` in contributor PRs. Maintainers or ClawSweeper add the changelog entry when landing user-facing changes. - Run tests: `pnpm build && pnpm check && pnpm test` - For iterative local commits, `scripts/committer --fast "message" ` passes `FAST_COMMIT=1` through to the pre-commit hook so it skips the repo-wide `pnpm check`. Only use it when you've already run equivalent targeted validation for the touched surface.