mirror of
https://github.com/cloudflare/cloudflare-docs.git
synced 2026-01-16 23:11:06 +00:00
2.1 KiB
2.1 KiB
| description | agent | subtask |
|---|---|---|
| Create a pull request for current branch changes | build | true |
Create a GitHub pull request for the current branch's changes against the default branch.
User Context
$ARGUMENTS
Instructions
-
Gather context: Run these commands to understand the changes:
git log --oneline production..HEADto see commits on this branchgit diff production...HEAD --statto see files changedgit diff production...HEADto see the actual changes
-
Identify the product: Determine which Cloudflare product(s) the changes relate to. Common products include:
- Workers, KV, R2, D1, Queues, Durable Objects (DO), Hyperdrive, Containers, Pipelines
- Pages, Images, Stream, Calls
- WAF, DDoS, Bot Management, API Shield, Page Shield
- Zero Trust (ZT), Access, Gateway, WARP, Tunnel, CASB, DLP, DEX
- DNS, Registrar, SSL/TLS, Load Balancing, Spectrum
- Analytics, Logs, Notifications
Use short product names where common (DO, KV, ZT, etc.).
-
Create the PR title: Use format
{Product}: {short description}- Keep description under 50 characters
- Use imperative mood (add, fix, update, remove)
- Examples:
Workers: add streaming response docs,KV: fix metadata example,ZT: update Gateway policies
-
Write the PR body:
- Start with 1-2 sentences explaining WHY this PR exists (the motivation/context)
- Follow with a short bulleted list of major changes (< 6-7 words per line)
- Do NOT include headers like "## Summary" or "## Changes"
- Do NOT include a line-by-line play-by-play of every file changed
- Do NOT include verbose explanations or implementation details
- Keep the entire body under 10 lines
-
Create the PR: Use
gh pr createwith the title and body:gh pr create --title "Product: short description" --body "body content"
Example PR Body
Adds documentation for the new streaming response API that enables real-time data processing in Workers.
- Add streaming response guide
- Update fetch handler examples
- Add SSE configuration options
- Fix broken link in overview
Output
Show the PR URL when complete.