Skip to content

Commit efc104c

Browse files
btiernayclaude
andcommitted
feat: add GitHub pull request template
Add practical PR template tailored to docs-v2 monorepo structure and workflow. Template includes emoji headings matching Auth0 conventions, dedicated redirects section, references to authoring guidelines, and polite collaborative language. Key features: - Emoji headings (✏️ 📁 🔗 ✅ 🔄 📊 🚀 📝 💬) matching Auth0 style - Redirects section with guidance and JSON example (critical given 4,201+ existing redirects) - Link to .claude/skills/writing-auth0-docs/SKILL.md authoring guidelines - References section for Jira tickets and product specs - Polite, collaborative tone throughout instructions - Mintlify-specific validation commands (mint dev, mint broken-links, mint a11y) - No feature flag references (not applicable to public docs repo) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent b5e38e9 commit efc104c

File tree

1 file changed

+88
-0
lines changed

1 file changed

+88
-0
lines changed

.github/pull_request_template.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
## ✏️ Changes
2+
3+
Please describe what this PR changes and why. If this touches multiple documentation sites (`main/` and `auth4genai/`), please 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+
## 🔗 References
22+
23+
Link to Jira issues, product specs, or related discussions:
24+
25+
https://auth0team.atlassian.net/browse/<issue>
26+
27+
## 🎯 Testing
28+
29+
**Local validation:**
30+
- [ ] Ran `mint dev` in affected docs folder(s)
31+
- [ ] Checked for broken links with `mint broken-links` (if applicable)
32+
- [ ] Verified accessibility with `mint a11y` (if applicable)
33+
- [ ] Built UI library with `npm run build` (if UI changes)
34+
35+
**Style compliance:**
36+
- [ ] Follows [Auth0 Docs authoring guidelines](.claude/skills/writing-auth0-docs/SKILL.md)
37+
- [ ] Follows placeholder conventions (`YOUR_SOMETHING`, `<id-value>`)
38+
- [ ] Uses correct Auth0 terminology and sentence case for headings
39+
- [ ] Code blocks include language and filename where appropriate
40+
- [ ] All images wrapped in `<Frame>` components
41+
42+
## 🔄 Redirects
43+
44+
**Please add redirects if:**
45+
- [ ] Pages are being removed or URLs are changing
46+
- [ ] Navigation structure changes affect existing URLs
47+
48+
If redirects are needed, please add them to the `redirects` array in the appropriate `docs.json` file:
49+
```json
50+
{
51+
"source": "/docs/old-path",
52+
"destination": "/docs/new-path"
53+
}
54+
```
55+
56+
## 📊 Impact
57+
58+
**User-facing changes:**
59+
Please describe any user-facing impact:
60+
- Does this introduce new pages, remove pages, or change URLs?
61+
- Does this document a new feature, Early Access capability, or breaking change?
62+
- Are there plan restrictions (Enterprise/Professional) that need callouts?
63+
64+
**Dependencies:**
65+
Please note any dependencies or coordination needs:
66+
- Are there related PRs or release timing considerations?
67+
- Does this require coordination with Product, Legal, or Security teams?
68+
69+
## 🚀 Deployment
70+
71+
✅🚫 This can be deployed any time (Mintlify auto-deploys on merge to main)
72+
73+
<!--
74+
OR
75+
⚠️ This should not be merged until:
76+
- Other PR is merged because REASON
77+
- After date because REASON
78+
- Other condition: REASON
79+
-->
80+
81+
## 📝 Follow-up
82+
83+
- [ ] No follow-up needed
84+
- [ ] Follow-up issue/PR needed (describe below)
85+
86+
## 💬 Additional context
87+
88+
Please add any other context, screenshots, or preview links that would help reviewers.

0 commit comments

Comments
 (0)