Debian Codegraph @

new/.charlie/instructions/pull-requests.md

raw
1 # Pull Requests: house rules
2
3 - Always use the repository’s Pull Request (PR) Template. Fill out all sections, including links, context, and checklists. For breaking changes, document the migration clearly in the template.
4 - Always analyze the change for potential breaking changes. If any public API, runtime behavior, defaults, or supported environments change, treat it as breaking.
5 - Always use Conventional Commits format for PR titles: `type(scope): summary`.
6 - Use lowercase `type` and `scope` (e.g., `fix(node-resolve): …`, `feat(babel): …`).
7 - Keep the summary under ~72 characters; be specific and action‑oriented.
8 - For breaking changes, use the bang after the scope and annotate the PR template:
9 - Example: `feat(commonjs)!: drop Node 14 support`
10 - Also mark the PR Template’s breaking‑change section and include migration notes.
11 - Use `chore(repo): …` in PR titles for any PR that does not modify package source code (implementation) — docs, CI, release scripts, templates, configs, repo maintenance.
12 - If a PR is a repository management task (even when it touches a package’s meta files like `package.json`, `.d.ts`, or config), title it with `chore(repo): …`.
13 - Before marking a PR ready for review, run locally:
14 - `pnpm lint`
15 - `pnpm fix:js`
16
17 Examples
18
19 - Non‑breaking feature to a plugin: `feat(babel): add includeChunks/excludeChunks`
20 - Breaking change to a plugin: `fix(node-resolve)!: change default resolution for "imports" bare targets`
21 - Repo maintenance: `chore(repo): update PR template and lint settings`