Skip to content

Commit 425152b

Browse files
committed
docs: update .github/PULL_REQUEST_TEMPLATE.md via Apex Optimizer
1 parent e2d5587 commit 425152b

1 file changed

Lines changed: 63 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Pull Request Template
2+
3+
## 🎯 Purpose
4+
5+
Describe the *why* behind this PR. What problem does it solve? What feature does it add?
6+
7+
**Link to Issue(s):** (e.g., `Closes #123`)
8+
9+
---
10+
11+
## 📝 Changes
12+
13+
List the key changes introduced in this PR. Be concise and use bullet points.
14+
15+
* [ ] Added new feature X
16+
* [ ] Fixed bug Y
17+
* [ ] Refactored component Z
18+
* [ ] Updated documentation
19+
20+
---
21+
22+
## 🚀 How to Test
23+
24+
Provide clear, step-by-step instructions for how reviewers can test your changes.
25+
26+
1. **Prerequisites:** (e.g., `npm install`, `uv pip sync`)
27+
2. **Steps:**
28+
* Checkout branch `[your-branch-name]`
29+
* Run command `[command-to-run]`
30+
* Observe [expected outcome]
31+
3. **Specific Scenarios:** (If applicable, list edge cases or critical paths to test)
32+
33+
---
34+
35+
## 🧠 Reviewer Notes
36+
37+
Add any specific areas you'd like reviewers to focus on, potential concerns, or context that might be helpful for understanding the changes.
38+
39+
---
40+
41+
## ✅ Checklist
42+
43+
Ensure all the following points are addressed:
44+
45+
* [ ] My code follows the project's style guidelines (Apex standards).
46+
* [ ] I have performed a self-review of my own code.
47+
* [ ] I have commented my code, particularly in hard-to-understand areas.
48+
* [ ] I have made corresponding changes to the documentation (if applicable).
49+
* [ ] My changes generate no new warnings or errors.
50+
* [ ] I have added new tests that prove my fix is effective or that my feature works.
51+
* [ ] All new and existing unit tests pass locally with my changes.
52+
* [ ] Any dependent changes have been merged and published.
53+
* [ ] I have updated the `AGENTS.md` file if any new tools or commands were introduced.
54+
55+
---
56+
57+
## 📚 AI Agent Directives Alignment
58+
59+
This PR aligns with the AI Agent Directives as defined in `AGENTS.md` by [briefly explain how, e.g., implementing a new feature that adheres to the established architecture, fixing a bug that violates an AI-guided principle, etc.].
60+
61+
* **Current Tech Stack:** JavaScript, Browser Extension APIs, AI (Local Data Analysis/Nudges)
62+
* **Verification Commands:** (If new commands are relevant to AI testing)
63+
* `npm run test:ai` (Example)

0 commit comments

Comments
 (0)