Create Pr

1---
2name: create-pr
3description: ALWAYS use this skill when creating pull requests — never create a PR directly without it. Follows Sentry conventions for PR titles, descriptions, and issue references. Trigger on any create PR, open PR, submit PR, make PR, push and create PR, or prepare changes for review task.
4---
5 
6# Create Pull Request
7 
8Create pull requests following Sentry's engineering practices.
9 
10**Requires**: GitHub CLI (`gh`) authenticated and available.
11 
12## Prerequisites
13 
14Before creating a PR, ensure all changes are committed. If there are uncommitted changes, run the `sentry-skills:commit` skill first to commit them properly.
15 
16```bash
17# Check for uncommitted changes
18git status --porcelain
19```
20 
21If the output shows any uncommitted changes (modified, added, or untracked files that should be included), invoke the `sentry-skills:commit` skill before proceeding.
22 
23## Process
24 
25### Step 1: Verify Branch State
26 
27```bash
28# Detect the default branch — note the output for use in subsequent commands
29gh repo view --json defaultBranchRef --jq '.defaultBranchRef.name'
30```
31 
32```bash
33# Check current branch and status (substitute the detected branch name above for BASE)
34git status
35git log BASE..HEAD --oneline
36```
37 
38Ensure:
39- All changes are committed
40- Branch is up to date with remote
41- Changes are rebased on the base branch if needed
42 
43### Step 2: Analyze Changes
44 
45Review what will be included in the PR:
46 
47```bash
48# See all commits that will be in the PR (substitute detected branch name for BASE)
49git log BASE..HEAD
50 
51# See the full diff
52git diff BASE...HEAD
53```
54 
55Understand the scope and purpose of all changes before writing the description.
56 
57### Step 3: Write the PR Description
58 
59Use this structure for PR descriptions (ignoring any repository PR templates):
60 
61```markdown
62<brief description of what the PR does>
63 
64<why these changes are being made - the motivation>
65 
66<alternative approaches considered, if any>
67 
68<any additional context reviewers need>
69```
70 
71**Do NOT include:**
72- "Test plan" sections
73- Checkbox lists of testing steps
74- Redundant summaries of the diff
75 
76**Do include:**
77- Clear explanation of what and why
78- Links to relevant issues or tickets
79- Context that isn't obvious from the code
80- Notes on specific areas that need careful review
81 
82### Step 4: Create the PR
83 
84```bash
85gh pr create --draft --title "<type>(<scope>): <description>" --body "$(cat <<'EOF'
86<description body here>
87EOF
88)"
89```
90 
91**Title format** follows commit conventions:
92- `feat(scope): Add new feature`
93- `fix(scope): Fix the bug`
94- `ref: Refactor something`
95 
96## PR Description Examples
97 
98### Feature PR
99 
100```markdown
101Add Slack thread replies for alert notifications
102 
103When an alert is updated or resolved, we now post a reply to the original
104Slack thread instead of creating a new message. This keeps related
105notifications grouped and reduces channel noise.
106 
107Previously considered posting edits to the original message, but threading
108better preserves the timeline of events and works when the original message
109is older than Slack's edit window.
110 
111Refs SENTRY-1234
112```
113 
114### Bug Fix PR
115 
116```markdown
117Handle null response in user API endpoint
118 
119The user endpoint could return null for soft-deleted accounts, causing
120dashboard crashes when accessing user properties. This adds a null check
121and returns a proper 404 response.
122 
123Found while investigating SENTRY-5678.
124 
125Fixes SENTRY-5678
126```
127 
128### Refactor PR
129 
130```markdown
131Extract validation logic to shared module
132 
133Moves duplicate validation code from the alerts, issues, and projects
134endpoints into a shared validator class. No behavior change.
135 
136This prepares for adding new validation rules in SENTRY-9999 without
137duplicating logic across endpoints.
138```
139 
140## Issue References
141 
142Reference issues in the PR body:
143 
144| Syntax | Effect |
145|--------|--------|
146| `Fixes #1234` | Closes GitHub issue on merge |
147| `Fixes SENTRY-1234` | Closes Sentry issue |
148| `Refs GH-1234` | Links without closing |
149| `Refs LINEAR-ABC-123` | Links Linear issue |
150 
151## Guidelines
152 
153- **One PR per feature/fix** - Don't bundle unrelated changes
154- **Keep PRs reviewable** - Smaller PRs get faster, better reviews
155- **Explain the why** - Code shows what; description explains why
156- **Mark WIP early** - Use draft PRs for early feedback
157 
158## Editing Existing PRs
159 
160If you need to update a PR after creation, use `gh api` instead of `gh pr edit`:
161 
162```bash
163# Update PR description
164gh api -X PATCH repos/{owner}/{repo}/pulls/PR_NUMBER -f body="$(cat <<'EOF'
165Updated description here
166EOF
167)"
168 
169# Update PR title
170gh api -X PATCH repos/{owner}/{repo}/pulls/PR_NUMBER -f title='new: Title here'
171 
172# Update both
173gh api -X PATCH repos/{owner}/{repo}/pulls/PR_NUMBER \
174  -f title='new: Title' \
175  -f body='New description'
176```
177 
178Note: `gh pr edit` is currently broken due to GitHub's Projects (classic) deprecation.
179 
180## References
181 
182- [Sentry Code Review Guidelines](https://develop.sentry.dev/engineering-practices/code-review/)
183- [Sentry Commit Messages](https://develop.sentry.dev/engineering-practices/commit-messages/)
184