feat: add GitHub pull request template #301
Closed
+148
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
btiernay
force-pushed
the
feat/add-pr-template
branch
from
f6e0f8f to
5be2672
Compare
This comment was marked as resolved.
This comment was marked as resolved.
btiernay
force-pushed
the
feat/add-pr-template
branch
from
5be2672 to
efc104c
Compare
avanscoy
added
DO NOT MERGE
documentation
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 <noreply@anthropic.com>
btiernay
force-pushed
the
feat/add-pr-template
branch
from
efc104c to
218e741
Compare
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Add i18n section to remind contributors to consider localized content updates when modifying main docs. Main docs support French Canadian (fr-ca/) and Japanese (ja-jp/) locales. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This comment was marked as outdated.
This comment was marked as outdated.
btiernay
force-pushed
the
feat/add-pr-template
branch
2 times, most recently
from
38b3696 to
b113dba
Compare
btiernay
force-pushed
the
feat/add-pr-template
branch
from
b113dba to
4058b3b
Compare
mikemimik
reviewed
Dec 10, 2025
|
|
||
| - [ ] Shared UI library (`ui/`) | ||
| - [ ] GitHub workflows (`.github/workflows/`) | ||
| - [ ] Tooling or scripts (`tools/`) |
Contributor
There was a problem hiding this comment.
Nit: We'll be creating a scripts/ folder soon that will start to get updates.
Suggested change
| - [ ] Tooling or scripts (`tools/`) | |
| - [ ] Tooling or scripts (`scripts/`) |
| - [ ] Code examples or snippets | ||
| - [ ] UI component or Mintlify configuration | ||
| - [ ] GitHub workflows (`.github/workflows/`) | ||
| - [ ] Scripts or tooling (`tools/`) |
Contributor
There was a problem hiding this comment.
re: previous comment
Suggested change
| - [ ] Scripts or tooling (`tools/`) | |
| - [ ] Scripts or tooling (`scripts/`) |
| - [ ] Update to existing content | ||
| - [ ] Navigation or structure change | ||
| - [ ] Code examples or snippets | ||
| - [ ] UI component or Mintlify configuration |
Contributor
There was a problem hiding this comment.
Nit: don't think it's necessary to describe implementation
Suggested change
| - [ ] UI component or Mintlify configuration | |
| - [ ] UI component or docs configuration |
Contributor
|
❓ Question: @btiernay is there any way we can make this more concise? |
Contributor
Author
|
Thanks for the feedback @mikemimik. Agree that this can be made more concise. Having now a better understanding of the repo mechanics than when I opened it, much of this I think can be either automated, documented elsewhere, or inferred. While there are some good things here we likely want to include, I'm going to close the PR in favour of these other avenues for now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Before you begin
By opening this PR, you agree to the terms of the Auth0 Code of Conduct. For guidance on creating a high-quality PR, see the Contributing Guidelines.
✏️ Changes
Adds a practical PR template tailored to the docs-v2 monorepo structure and workflow. The template includes dedicated sections for redirects, testing steps, and style requirements. It aligns with Auth0 documentation conventions and reduces friction when opening new PRs.
Preview of the template:
📁 Documentation scope
Docs site(s) affected
main/auth4genai/Other areas
ui/).github/workflows/)tools/)Type of change
.github/workflows/)tools/)🔗 References
Derived from existing Auth0 internal PR patterns and aligned with the structure used across active documentation repos.
🎯 Testing
Local validation
mint devin affected foldersmint broken-links(when applicable)mint a11y(when applicable)npm run buildinui/(for UI changes)Style and structure
Repo checks
Notes: Template renders cleanly in GitHub. Checkboxes and sections are correctly formatted. Command references match our tooling (
mint dev,mint broken-links,mint a11y).🔄 Redirects
Not applicable - no URLs were added, removed, or modified.
🌍 Internationalization (main docs only)
main/🧩 Impact and dependencies
User-facing impact
main/,auth4genai/, and the shared UI libraryDependencies
None
🚀 Deployment
📝 Follow-up
💬 Additional context
The template aims to keep the process lightweight and predictable.
It surfaces the most common reviewer needs upfront: redirects, terminology alignment, testing steps, and per-site scope.
Tip
Useful references: