mirror of
https://github.com/n8n-io/n8n
synced 2026-04-21 15:47:20 +00:00
chore: Update create-pr skill and PR template (no-changelog) (#28302)
This commit is contained in:
parent
290005e0e8
commit
54881e189d
4 changed files with 14 additions and 19 deletions
|
|
@ -4,7 +4,6 @@ description: >-
|
||||||
Use when adding a lint rule, creating a community node lint, or working on
|
Use when adding a lint rule, creating a community node lint, or working on
|
||||||
eslint-plugin-community-nodes. Guides rule implementation, tests, docs, and
|
eslint-plugin-community-nodes. Guides rule implementation, tests, docs, and
|
||||||
plugin registration.
|
plugin registration.
|
||||||
user_invocable: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Create Community Node Lint Rule
|
# Create Community Node Lint Rule
|
||||||
|
|
|
||||||
|
|
@ -72,24 +72,17 @@ Creates GitHub PRs with titles that pass n8n's `check-pr-title` CI validation.
|
||||||
git push -u origin HEAD
|
git push -u origin HEAD
|
||||||
```
|
```
|
||||||
|
|
||||||
6. **Create PR** using gh CLI with the template from `.github/pull_request_template.md`:
|
6. **Create PR** using gh CLI. Read `.github/pull_request_template.md` as the
|
||||||
|
body structure, then populate each section with actual content before
|
||||||
|
creating the PR:
|
||||||
|
- **Summary**: describe what the PR does and how to test it
|
||||||
|
- **Related tickets**: add the Linear ticket URL (`https://linear.app/n8n/issue/[TICKET-ID]`) and any GitHub issue links
|
||||||
|
- **Checklist**: keep as-is from the template
|
||||||
|
- Add a "🤖 PR Summary generated by AI" at the end of the body
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
gh pr create --draft --title "<type>(<scope>): <summary>" --body "$(cat <<'EOF'
|
gh pr create --draft --title "<type>(<scope>): <summary>" --body "$(cat <<'EOF'
|
||||||
## Summary
|
<populated body based on pull_request_template.md>
|
||||||
|
|
||||||
<Describe what the PR does and how to test. Photos and videos are recommended.>
|
|
||||||
|
|
||||||
## Related Linear tickets, Github issues, and Community forum posts
|
|
||||||
|
|
||||||
<!-- Link to Linear ticket: https://linear.app/n8n/issue/[TICKET-ID] -->
|
|
||||||
<!-- Use "closes #<issue-number>", "fixes #<issue-number>", or "resolves #<issue-number>" to automatically close issues -->
|
|
||||||
|
|
||||||
## Review / Merge checklist
|
|
||||||
|
|
||||||
- [ ] PR title and summary are descriptive. ([conventions](../blob/master/.github/pull_request_title_conventions.md))
|
|
||||||
- [ ] [Docs updated](https://github.com/n8n-io/n8n-docs) or follow-up ticket created.
|
|
||||||
- [ ] Tests included.
|
|
||||||
- [ ] PR Labeled with `release/backport` (if the PR is an urgent fix that needs to be backported)
|
|
||||||
EOF
|
EOF
|
||||||
)"
|
)"
|
||||||
```
|
```
|
||||||
|
|
@ -111,6 +104,7 @@ Based on `.github/pull_request_template.md`:
|
||||||
|
|
||||||
### Checklist
|
### Checklist
|
||||||
All items should be addressed before merging:
|
All items should be addressed before merging:
|
||||||
|
- 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." checkbox
|
||||||
- PR title follows conventions
|
- PR title follows conventions
|
||||||
- Docs updated or follow-up ticket created
|
- Docs updated or follow-up ticket created
|
||||||
- Tests included (bugs need regression tests, features need coverage)
|
- Tests included (bugs need regression tests, features need coverage)
|
||||||
|
|
@ -191,5 +185,8 @@ Describe **what the code does**, not what threat it prevents.
|
||||||
| Linear ref | URL with slug (leaks title) | URL without slug or ticket ID only |
|
| Linear ref | URL with slug (leaks title) | URL without slug or ticket ID only |
|
||||||
| Test name | `'should prevent SQL injection'` | `'should sanitize query parameters'` |
|
| Test name | `'should prevent SQL injection'` | `'should sanitize query parameters'` |
|
||||||
|
|
||||||
|
|
||||||
**Before pushing a security fix, verify:** no branch name, commit, PR title,
|
**Before pushing a security fix, verify:** no branch name, commit, PR title,
|
||||||
PR body, Linear URL, test name, or code comment hints at the vulnerability.
|
PR body, Linear URL, test name, or code comment hints at the vulnerability.
|
||||||
|
|
||||||
|
**When in doubt, check the Linear issue for possible extra precautions**
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,5 @@
|
||||||
---
|
---
|
||||||
description: Reproduce a bug from a Linear ticket with a failing test. Expects the full ticket context (title, description, comments) to be provided as input.
|
description: Reproduce a bug from a Linear ticket with a failing test. Expects the full ticket context (title, description, comments) to be provided as input.
|
||||||
user_invocable: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Bug Reproduction Framework
|
# Bug Reproduction Framework
|
||||||
|
|
|
||||||
2
.github/pull_request_template.md
vendored
2
.github/pull_request_template.md
vendored
|
|
@ -10,7 +10,7 @@ Photos and videos are recommended.
|
||||||
<!--
|
<!--
|
||||||
Include links to **Linear ticket** or Github issue or Community forum post.
|
Include links to **Linear ticket** or Github issue or Community forum post.
|
||||||
Important in order to close *automatically* and provide context to reviewers.
|
Important in order to close *automatically* and provide context to reviewers.
|
||||||
https://linear.app/n8n/issue/
|
https://linear.app/n8n/issue/[TICKET-ID]
|
||||||
-->
|
-->
|
||||||
<!-- Use "closes #<issue-number>", "fixes #<issue-number>", or "resolves #<issue-number>" to automatically close issues when the PR is merged. -->
|
<!-- Use "closes #<issue-number>", "fixes #<issue-number>", or "resolves #<issue-number>" to automatically close issues when the PR is merged. -->
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue