Skip to content

Commit 8a4d84a

Browse files
authored
Create pull_request_template.md (#162)
1 parent ad75ef0 commit 8a4d84a

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

.github/pull_request_template.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## ✅ PR Checklist
2+
3+
- [ ] Target branch is `dev`
4+
5+
📌 Note: PRs must be raised against `dev`. Do not commit directly to `main`.
6+
7+
### ✅ Testing & CI
8+
- [ ] Have tested the changes in my local environment, else have properly conveyed in the PR description
9+
- [ ] The change includes a GitHub Action to test the script(if it is possible to be added).
10+
- [ ] No existing GitHub Actions are failing because of this change.
11+
12+
### 📚 Documentation
13+
- [ ] README or help docs are updated for new features or changes.
14+
- [ ] CLI help messages are meaningful and complete.
15+
16+
### 📁 File Hygiene & Output Handling
17+
- [ ] No unintended files (e.g., logs, cache, temp files, __pycache__, output folders) are committed.
18+
19+
### 🛡️ Safety & Security
20+
- [ ] No secrets or credentials are committed.
21+
- [ ] Paths, shell commands, and environment handling are safe and portable.
22+
23+
### 🙌 Contribution Hygiene
24+
- [ ] PR title and description are concise and clearly state the purpose of the change.
25+
- [ ] Related issues (if any) are properly referenced using `Fixes #` or `Closes #`.
26+
- [ ] All reviewer feedback has been addressed.

0 commit comments

Comments
 (0)