Skip to content

Commit f6e0f8f

Browse files
btiernayclaude
andcommitted
style: add polite language to PR template instructions
Soften directive tone with "please" throughout template instructions to create a more collaborative and friendly contribution experience. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 7abeb9d commit f6e0f8f

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

.github/pull_request_template.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## ✏️ Changes
22

3-
Briefly describe what this PR changes and why. If this touches multiple documentation sites (`main/` and `auth4genai/`), call that out.
3+
Please briefly describe what this PR changes and why. If this touches multiple documentation sites (`main/` and `auth4genai/`), please call that out.
44

55
## 📁 Documentation scope
66

@@ -20,7 +20,7 @@ Briefly describe what this PR changes and why. If this touches multiple document
2020

2121
## 🔗 References
2222

23-
Link to Jira issues, product specs, or related discussions:
23+
Please link to any related Jira issues, product specs, or relevant discussions:
2424

2525
https://auth0team.atlassian.net/browse/<issue>
2626

@@ -41,11 +41,11 @@ https://auth0team.atlassian.net/browse/<issue>
4141

4242
## 🔄 Redirects
4343

44-
**Required if:**
44+
**Please add redirects if:**
4545
- [ ] Pages are being removed or URLs are changing
4646
- [ ] Navigation structure changes affect existing URLs
4747

48-
If redirects are needed, add them to the `redirects` array in the appropriate `docs.json` file:
48+
If redirects are needed, please add them to the `redirects` array in the appropriate `docs.json` file:
4949
```json
5050
{
5151
"source": "/docs/old-path",
@@ -56,11 +56,13 @@ If redirects are needed, add them to the `redirects` array in the appropriate `d
5656
## 📊 Impact
5757

5858
**User-facing changes:**
59+
Please describe any user-facing impact:
5960
- Does this introduce new pages, remove pages, or change URLs?
6061
- Does this document a new feature, Early Access capability, or breaking change?
6162
- Are there plan restrictions (Enterprise/Professional) that need callouts?
6263

6364
**Dependencies:**
65+
Please note any dependencies or coordination needs:
6466
- Are there related PRs or release timing considerations?
6567
- Does this require coordination with Product, Legal, or Security teams?
6668

@@ -83,4 +85,4 @@ OR
8385

8486
## 💬 Additional context
8587

86-
Add any other context, screenshots, or preview links that help reviewers.
88+
Please add any other context, screenshots, or preview links that would help reviewers.

0 commit comments

Comments
 (0)