-
Notifications
You must be signed in to change notification settings - Fork 30
feat: add GitHub pull request template #301
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,148 @@ | ||||||
| ## 📝 Before you begin | ||||||
|
|
||||||
| By opening this PR, you agree to the terms of the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md). For guidance on creating a high-quality PR, see the [Contributing Guidelines](CONTRIBUTING.md). | ||||||
|
|
||||||
| ## ✏️ Changes | ||||||
|
|
||||||
| Describe what this PR changes and why. Keep it brief. | ||||||
|
|
||||||
| - What problem does it solve? | ||||||
| - Which docs or UI areas are affected? | ||||||
| - Does it span more than one docs site (`main/`, `auth4genai/`) or the shared UI library (`ui/`)? | ||||||
|
|
||||||
| ## 📁 Documentation scope | ||||||
|
|
||||||
| **Docs site(s) affected** | ||||||
|
|
||||||
| - [ ] `main/` | ||||||
| - [ ] `auth4genai/` | ||||||
|
|
||||||
| **Other areas** | ||||||
|
|
||||||
| - [ ] Shared UI library (`ui/`) | ||||||
| - [ ] GitHub workflows (`.github/workflows/`) | ||||||
| - [ ] Tooling or scripts (`tools/`) | ||||||
|
|
||||||
| **Type of change** | ||||||
|
|
||||||
| - [ ] New page or major section | ||||||
| - [ ] 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: don't think it's necessary to describe implementation
Suggested change
|
||||||
| - [ ] GitHub workflows (`.github/workflows/`) | ||||||
| - [ ] Scripts or tooling (`tools/`) | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. re: previous comment
Suggested change
|
||||||
|
|
||||||
| Add paths or permalinks if it helps reviewers. | ||||||
|
|
||||||
| ## 🔗 References | ||||||
|
|
||||||
| Link any related issues, design docs, or connected PRs. | ||||||
|
|
||||||
| - Issue(s): # | ||||||
| - Related work: | ||||||
|
|
||||||
| ## 🎯 Testing | ||||||
|
|
||||||
| Mark what you validated and note anything skipped. | ||||||
| (Unit tests do not apply in this repo.) | ||||||
|
|
||||||
| **Local validation** | ||||||
|
|
||||||
| - [ ] Content-only change (no build or navigation impact) | ||||||
| - [ ] `mint dev` in affected folders | ||||||
| - [ ] `mint broken-links` (when applicable) | ||||||
| - [ ] `mint a11y` (when applicable) | ||||||
| - [ ] `npm run build` in `ui/` (for UI changes) | ||||||
|
|
||||||
| **Style and structure** | ||||||
|
|
||||||
| - [ ] Follows the Contributing Guidelines | ||||||
| - [ ] Uses correct Auth0 terminology | ||||||
| - [ ] Code blocks include language and filenames when needed | ||||||
|
|
||||||
| **Repo checks** | ||||||
|
|
||||||
| - [ ] All required GitHub checks are passing | ||||||
| - [ ] The correct base branch is used | ||||||
|
|
||||||
| If something was not run or does not apply, note it here. | ||||||
|
|
||||||
| ## 🔄 Redirects | ||||||
|
|
||||||
| Use this section only if URLs change. | ||||||
|
|
||||||
| - [ ] Pages removed or permalinks changed | ||||||
| - [ ] Navigation changes that alter existing URLs | ||||||
|
|
||||||
| If redirects are needed, update the relevant `docs.json` and list them here: | ||||||
|
|
||||||
| ```json | ||||||
| [ | ||||||
| { | ||||||
| "source": "/docs/old-path", | ||||||
| "destination": "/docs/new-path" | ||||||
| } | ||||||
| ] | ||||||
| ``` | ||||||
|
|
||||||
| ## 🌍 Internationalization (main docs only) | ||||||
|
|
||||||
| * [ ] Not applicable - no English content changes in `main/` | ||||||
| * [ ] English only; localization handled separately | ||||||
| * [ ] Includes updates to localized content (for example, `main/docs/fr-ca/`, `main/docs/ja-jp/`) | ||||||
|
|
||||||
| Add notes if something needs follow-up in localized folders. | ||||||
|
|
||||||
| ## 🧩 Impact and dependencies | ||||||
|
|
||||||
| **User-facing impact** | ||||||
|
|
||||||
| Summarize what readers will notice: | ||||||
|
|
||||||
| * New or removed pages | ||||||
| * URL changes | ||||||
| * New feature, Early Access feature, or breaking change | ||||||
| * Plan restrictions that need callouts | ||||||
|
|
||||||
| **Dependencies** | ||||||
|
|
||||||
| List anything this PR depends on or influences: | ||||||
|
|
||||||
| * Product release timing | ||||||
| * Related PRs or repos | ||||||
| * Follow-up docs needed after merge | ||||||
|
|
||||||
| ## 🚀 Deployment | ||||||
|
|
||||||
| * [ ] Safe to deploy on merge | ||||||
| * [ ] Do not merge until a condition is met | ||||||
|
|
||||||
| If blocked, state the condition: | ||||||
|
|
||||||
| * Dependent PRs: | ||||||
| * Date or window: | ||||||
| * Other requirement: | ||||||
|
|
||||||
| ## 📝 Follow-up | ||||||
|
|
||||||
| * [ ] No follow-up needed | ||||||
| * [ ] Follow-up work required | ||||||
|
|
||||||
| Add links or describe next steps if needed. | ||||||
|
|
||||||
| ## 💬 Additional context | ||||||
|
|
||||||
| Optional. Add anything reviewers should know: | ||||||
|
|
||||||
| * Specific pages in the Mintlify preview you want checked | ||||||
| * Screenshots or diagrams (with alt text) | ||||||
| * Notes for specific reviewers | ||||||
|
|
||||||
| > [!TIP] | ||||||
| > Useful references: | ||||||
| > | ||||||
| > * [Contributing Guidelines](CONTRIBUTING.md) | ||||||
| > * Mintlify documentation: [https://www.mintlify.com/docs](https://www.mintlify.com/docs) | ||||||
| > * [main README](main/README.md) | ||||||
| > * [auth4genai README](auth4genai/README.md) | ||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: We'll be creating a
scripts/folder soon that will start to get updates.