n8n:create-pr

Source excerpt starting at line 1.

1---2name: n8n:create-pr3description: Creates GitHub pull requests with properly formatted titles that pass the check-pr-title CI validation. Use when creating PRs, submitting changes for review, or when the user says /pr or asks to create a pull request.4allowed-tools: Bash(git:*), Bash(gh:*), Read, Grep, Glob5---6 7# Create Pull Request8 9Creates GitHub PRs with titles that pass n8n's `check-pr-title` CI validation.10 11## PR Title Format12 13```14<type>(<scope>): <summary>15```16 17### Types (required)18 19| Type       | Description                                      | Changelog |20|------------|--------------------------------------------------|-----------|21| `feat`     | New feature                                      | Yes       |22| `fix`      | Bug fix                                          | Yes       |23| `perf`     | Performance improvement                          | Yes       |24| `test`     | Adding/correcting tests                          | No        |25| `docs`     | Documentation only                               | No        |26| `refactor` | Code change (no bug fix or feature)              | No        |27| `build`    | Build system or dependencies                     | No        |28| `ci`       | CI configuration                                 | No        |29| `chore`    | Routine tasks, maintenance                       | No        |30 31### Scopes (optional but recommended)32 33- `API` - Public API changes34- `benchmark` - Benchmark CLI changes35- `core` - Core/backend/private API36- `editor` - Editor UI changes37- `engine` - New workflow execution engine v2 (@n8n/engine package)38- `* Node` - Specific node (e.g., `Slack Node`, `GitHub Node`)39 40### Summary Rules41 42- Use imperative present tense: "Add" not "Added"43- Capitalize first letter44- No period at the end45- No ticket IDs (e.g., N8N-1234)46- Add `(no-changelog)` suffix to exclude from changelog47 48## Steps49 501. **Check current state**:51   ```bash52   git status53   git diff --stat54   git log origin/master..HEAD --oneline55   ```56 572. **Check for implementation plan**: Look for a plan file in the repository plan directories (`.claude/plans/` or `.agents/plans/` when present)58   that matches the current branch's ticket ID (e.g. if branch is59   `scdekov/PAY-1234-some-feature`, check for `PAY-1234.md`).60   If a plan file exists, ask the user whether they want to include it in the61   PR description as a collapsible `<details>` section (see Plan Section below).62   Only include the plan if the user explicitly approves.63 643. **If this is a security fix**, audit every public-facing artifact before65   proceeding (see Security Fixes below).66 674. **Analyze changes** to determine:68   - Type: What kind of change is this?69   - Scope: Which package/area is affected?70   - Summary: What does the change do?71 725. **Push branch if needed**:73   ```bash74   git push -u origin HEAD75   ```76 776. **Create PR** using gh CLI. Read `.github/pull_request_template.md` as the78   body structure, then populate each section with actual content before79   creating the PR:80   - **Summary**: describe what the PR does81   - **How to test**: describe how to test the changes. Include an example workflow if appropriate82   - **Related tickets**: add the Linear ticket URL (`https://linear.app/n8n/issue/[TICKET-ID]`) and any GitHub issue links83   - **Checklist**: keep as-is from the template84	 - Add a "🤖 PR Summary generated by AI" at the end of the body85 86   ```bash87   gh pr create --draft --title "<type>(<scope>): <summary>" --body "$(cat <<'EOF'88   <populated body based on pull_request_template.md>89   EOF90   )"91   ```92 93## PR Body Guidelines94 95Based on `.github/pull_request_template.md`:96 97Write the PR body in ASD-STE100 Simplified Technical English: use short98sentences, the active voice, and one instruction for each sentence.99 100### Summary Section101- Describe what the PR does102- Include screenshots/videos for UI changes103 104### How to test Section105- Explain how to test the changes106- Include an example workflow if appropriate107- If the feature is gated in a default n8n instance (requires a non-default108  module via `N8N_ENABLED_MODULES`, an enterprise license, a feature flag, or109  similar), note which env vars/license are needed so the tester can deploy a110  correctly configured instance111 112### Related Links Section113- Link to Linear ticket: `https://linear.app/n8n/issue/[TICKET-ID]`114- Link to GitHub issues using keywords to auto-close:115  - `closes #123` / `fixes #123` / `resolves #123`116- Link to Community forum posts if applicable117 118### Checklist119All items should be addressed before merging:120- The human author of the PR has checked the "I have seen this code, I have run this code, and I take responsibility for this code." checkbox121- PR title follows conventions122- Docs updated or follow-up ticket created123- Tests included (bugs need regression tests, features need coverage)124- `release/backport` label added if urgent fix needs backporting125 126## Examples127 128### Feature in editor129```130feat(editor): Add workflow performance metrics display131```132 133### Bug fix in core134```135fix(core): Resolve memory leak in execution engine136```137 138### Node-specific change139```140fix(Slack Node): Handle rate limiting in message send141```142 143### Breaking change (add exclamation mark before colon)144```145feat(API)!: Remove deprecated v1 endpoints146```147 148### No changelog entry149```150refactor(core): Simplify error handling (no-changelog)151```152 153### No scope (affects multiple areas)154```155chore: Update dependencies to latest versions156```157 158## Validation159 160The PR title must match this pattern:161```162^(feat|fix|perf|test|docs|refactor|build|ci|chore|revert)(\([a-zA-Z0-9 ]+( Node)?\))?!?: [A-Z].+[^.]$163```164 165Key validation rules:166- Type must be one of the allowed types167- Scope is optional but must be in parentheses if present168- Exclamation mark for breaking changes goes before the colon169- Summary must start with capital letter170- Summary must not end with a period171 172## Plan Section173 174If a matching plan file was found in a repository plan directory and the user has approved175including it, add a collapsible section at the end of the PR body (after the176checklist, before `EOF`):177 178```markdown179<details>180<summary>Implementation plan</summary>181 182<!-- paste plan file contents here -->183 184</details>185```186 187## Security Fixes188 189**This repo is public.** Never expose the attack vector in any public artifact.190Describe **what the code does**, not what threat it prevents.191 192| Artifact | BAD | GOOD |193|---|---|---|194| Branch | `fix-sql-injection-in-webhook` | `fix-webhook-input-validation` |195| PR title | `fix(core): Prevent SSRF` | `fix(core): Validate outgoing URLs` |196| Commit msg | `fix: prevent denial of service` | `fix: add payload size validation` |197| PR body | *"attacker could trigger SSRF…"* | *"validates URL protocol and host"* |198| Linear ref | URL with slug (leaks title) | URL without slug or ticket ID only |199| Test name | `'should prevent SQL injection'` | `'should sanitize query parameters'` |200 201 202**Before pushing a security fix, verify:** no branch name, commit, PR title,203PR body, Linear URL, test name, or code comment hints at the vulnerability.204 205**When in doubt, check the Linear issue for possible extra precautions**206