From 0097ca80e260c9b1068cc1594f86e924c510ec47 Mon Sep 17 00:00:00 2001 From: Phantom Date: Sun, 30 Nov 2025 18:39:47 +0800 Subject: [PATCH] docs: improve CLAUDE.md PR workflow guidelines (#11548) docs: update CLAUDE.md with PR workflow details Add critical section about Pull Request workflow requirements including reading the template, following all sections, never skipping, and proper formatting --- CLAUDE.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CLAUDE.md b/CLAUDE.md index 88ab1a116..c96fc0e40 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -12,7 +12,15 @@ This file provides guidance to AI coding assistants when working with code in th - **Always propose before executing**: Before making any changes, clearly explain your planned approach and wait for explicit user approval to ensure alignment and prevent unwanted modifications. - **Lint, test, and format before completion**: Coding tasks are only complete after running `yarn lint`, `yarn test`, and `yarn format` successfully. - **Write conventional commits**: Commit small, focused changes using Conventional Commit messages (e.g., `feat:`, `fix:`, `refactor:`, `docs:`). -- **Follow PR template**: When submitting pull requests, follow the template in `.github/pull_request_template.md` to ensure complete context and documentation. + +## Pull Request Workflow (CRITICAL) + +When creating a Pull Request, you MUST: + +1. **Read the PR template first**: Always read `.github/pull_request_template.md` before creating the PR +2. **Follow ALL template sections**: Structure the `--body` parameter to include every section from the template +3. **Never skip sections**: Include all sections even if marking them as N/A or "None" +4. **Use proper formatting**: Match the template's markdown structure exactly (headings, checkboxes, code blocks) ## Development Commands