Skip to content

Commit 311b368

Browse files
btiernayclaude
andcommitted
feat: add GitHub pull request template
Add practical PR template tailored to docs-v2 monorepo structure and workflow. Template includes sections for documentation scope, local validation commands, style compliance, and impact assessment. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent b5e38e9 commit 311b368

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

.github/pull_request_template.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## Summary
2+
3+
Briefly describe what this PR changes and why. If this touches multiple documentation sites (`main/` and `auth4genai/`), call that out.
4+
5+
## Documentation scope
6+
7+
**Site(s) affected:**
8+
- [ ] `main/` - Auth0 main documentation
9+
- [ ] `auth4genai/` - Auth0 for AI Agents documentation
10+
- [ ] `ui/` - Shared component library
11+
- [ ] Infrastructure/tooling
12+
13+
**Type of change:**
14+
- [ ] New documentation
15+
- [ ] Update to existing documentation
16+
- [ ] Navigation/information architecture change
17+
- [ ] Code examples or snippets
18+
- [ ] UI component or Mintlify configuration
19+
- [ ] Linting/tooling/workflows
20+
21+
## Verification
22+
23+
**Local validation:**
24+
- [ ] Ran `mint dev` in affected docs folder(s)
25+
- [ ] Checked for broken links with `mint broken-links` (if applicable)
26+
- [ ] Verified accessibility with `mint a11y` (if applicable)
27+
- [ ] Built UI library with `npm run build` (if UI changes)
28+
29+
**Style compliance:**
30+
- [ ] Follows placeholder conventions (`YOUR_SOMETHING`, `<id-value>`)
31+
- [ ] Uses correct Auth0 terminology and sentence case for headings
32+
- [ ] Code blocks include language and filename where appropriate
33+
- [ ] All images wrapped in `<Frame>` components
34+
35+
## Impact and dependencies
36+
37+
**User-facing changes:**
38+
- Does this introduce new pages, remove pages, or change URLs?
39+
- Does this document a new feature, Early Access capability, or breaking change?
40+
- Are there plan restrictions (Enterprise/Professional) that need callouts?
41+
42+
**Dependencies:**
43+
- Are there related PRs, feature flags, or release timing considerations?
44+
- Does this require coordination with Product, Legal, or Security teams?
45+
46+
**Follow-up required:**
47+
- [ ] No follow-up needed
48+
- [ ] Follow-up issue/PR needed (describe below)
49+
50+
## Additional context
51+
52+
Add any other context, screenshots, or preview links that help reviewers.

0 commit comments

Comments
 (0)