Skip to content

Commit ca675d6

Browse files
committed
docs: update .github/PULL_REQUEST_TEMPLATE.md via Apex Optimizer
1 parent c9132b3 commit ca675d6

File tree

1 file changed

+43
-45
lines changed

1 file changed

+43
-45
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 43 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,73 @@
1-
# Pull Request Checklist & Review Directive
1+
# Pull Request Template
22

3-
<!--
3+
## 🚀 High-Velocity Contribution Checklist
44

5-
Thank you for contributing to JSErrorFlow!
5+
**Please ensure all the following points are addressed before submitting your Pull Request:**
66

7-
Before submitting, please ensure this PR adheres to the Apex Technical Authority standards.
7+
### 1. ✨ Code Quality & Standards
88

9-
1. **Branch Naming:** Is your branch descriptive (e.g., `feature/new-dom-highlight` or `fix/error-parsing-bug`)?
10-
2. **Self-Review:** Have you reviewed your own changes against the architectural guidelines in AGENTS.md?
11-
3. **Testing:** Have you added/updated necessary unit/E2E tests?
12-
4. **Description:** Is the description clear, concise, and does it reference any related issues (e.g., `Closes #123`)?
9+
* [ ] My code adheres to the **Apex Technical Authority** standards (Zero-Defect, High-Velocity, Future-Proof).
10+
* [ ] Code is clean, well-commented, and follows established architectural patterns (e.g., SOLID, DRY).
11+
* [ ] New code is covered by comprehensive unit and/or integration tests.
12+
* [ ] All linting and formatting checks pass using the configured tools (e.g., Ruff for Python, Biome for TS/JS).
13+
* [ ] README.md, AGENTS.md, and other relevant documentation have been updated to reflect changes.
1314

14-
-->
15+
### 2. 🧪 Testing & Verification
1516

16-
## 🚀 Feature / Fix Summary
17+
* [ ] I have run all tests locally (`pytest` for Python, `vitest` for TS/JS) and they are passing.
18+
* [ ] If applicable, I have tested the changes manually in a development environment.
19+
* [ ] End-to-end tests (e.g., Playwright) have been considered and updated if necessary.
1720

18-
**Briefly describe the change this PR introduces.** (Why was this change necessary?)
21+
### 3. 📚 Documentation & Metadata
1922

20-
<!-- Example: Implements real-time error visualization for unhandled promise rejections by hooking into the global `unhandledrejection` event. -->
23+
* [ ] The **README.md** is updated with accurate descriptions, setup instructions, and usage examples.
24+
* [ ] **AGENTS.md** is updated with the latest directives, including any new technology stack or architectural decisions.
25+
* [ ] **Badges** in README.md and `badges.yml` are accurate and reflect the current build/coverage status.
26+
* [ ] Topics for the repository have been reviewed and updated if necessary.
2127

28+
### 4. 🚀 Deployment & CI/CD
2229

23-
[Describe the core change here]
30+
* [ ] CI/CD pipeline (`ci.yml`) is configured correctly and will execute the necessary build and test steps.
31+
* [ ] The changes do not introduce any regressions that would break the CI pipeline.
2432

33+
### 5. 📄 Licensing & Compliance
2534

26-
## Related Issues
35+
* [ ] All new code is compliant with the **CC BY-NC 4.0** license.
2736

28-
Closes/Fixes/Relates to: (e.g., `Closes #42`, `Fixes #10`)
37+
### 6. 🚨 Security Considerations
2938

30-
---
39+
* [ ] I have reviewed my changes for potential security vulnerabilities.
40+
* [ ] Sensitive information is not hardcoded or exposed.
41+
* [ ] Dependencies have been updated responsibly, and potential vulnerabilities have been addressed.
3142

32-
## ✅ Checklist
43+
---
3344

34-
**Developer Confirmation (Check all that apply):**
45+
## 📝 Description
3546

36-
- [ ] **Code Quality:** Linting passes without warnings (`npm run lint`).
37-
- [ ] **Formatting:** Code formatting is consistent (`npm run format`).
38-
- [ ] **Testing:** Unit tests (`npm run test:unit`) pass successfully for the added scope.
39-
- [ ] **Documentation:** Any new public APIs or significant behavioral changes are documented in the relevant source files or README.
40-
- [ ] **Architecture Alignment:** Changes adhere to the established FSD/WXT patterns outlined in `AGENTS.md`.
41-
- [ ] **Security:** No secrets exposed, and input sanitization has been applied where necessary (especially DOM manipulation).
47+
Please provide a concise description of your changes. What problem does this PR solve?
4248

43-
---
49+
## 💡 Motivation
4450

45-
## 🧠 Architecture & Technical Deep Dive
51+
Why are these changes necessary? What is the context?
4652

47-
**For non-trivial changes, detail the architectural impact or implementation decisions.**
53+
## 🗺️ Proposed Changes
4854

49-
1. **Component Impact:** Which main FSD layers were affected (e.g., `entities/error-model`, `features/visualizer-display`)?
50-
2. **DOM/Runtime Strategy:** How does this interact with the browser's event loop or MutationObserver (if applicable)?
51-
3. **Performance Considerations:** Are there any new DOM thrashing or excessive re-renders introduced? (Targeting sub-10ms updates).
55+
* [Link to related issue, if any]
56+
* Briefly list the key changes included in this PR.
5257

53-
markdown
54-
[Technical notes here]
58+
## 🎯 What was changed?
5559

60+
* [Provide a summary of the changes. Be specific.]
5661

57-
---
62+
## 🎯 How was this tested?
5863

59-
## 🖼️ Screenshots / Artifacts (If Applicable)
64+
* [Describe the testing procedures performed.]
6065

61-
<!-- If this PR affects the UI or observable behavior, include visual proof. -->
66+
## 📸 Screenshots (if applicable)
6267

63-
| Before | After |
64-
| :---: | :---: |
65-
| (Optional Screenshot/GIF) | (Optional Screenshot/GIF) |
68+
* [Add screenshots or recordings of the UI changes.]
6669

6770
---
6871

69-
## 🤖 Reviewer Guidance
70-
71-
**Please focus review efforts on the following areas:**
72-
73-
1. Performance implications of the new visualizer logic.
74-
2. Correctness of TypeScript type definitions introduced.
75-
3. Adherence to WXT extension lifecycle management.
72+
**Repository:** `https://github.com/chirag127/JSErrorFlow-Realtime-DOM-Error-Visualizer-Browser-Extension`
73+
**Username:** `chirag127`

0 commit comments

Comments
 (0)