Skip to content

Commit 76f653c

Browse files
committed
add: PR template
1 parent 6c40114 commit 76f653c

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

.github/pull_request_template.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
Remove this part when you open the PR
3+
4+
Here's a checklist before opening the Pull Request!
5+
6+
1. PR Title convention : [Type of PR] [Summary] (e.g. [Feature] Implement AdamP optimizer)
7+
2. Attach `as much information as possible you can`. It helps the reviewers a lot :)
8+
3. Make sure the code is perfectly `runnable & compatible`.
9+
4. If your PR is not ready yet, make your `PR` to `Draft PR`.
10+
5. Make sure `make check` before opening the `PR`.
11+
---
12+
13+
## Problem (Why?)
14+
15+
_What problem are you trying to solve?_
16+
17+
## Solution (What/How?)
18+
19+
_How did you solve the problem? Please provide a complete description and explanation!_
20+
21+
_It'd be appreciated to attach Change Logs or `Notion`, `Jira` link. If you train a model, then attach `Tensorboard` or `WanDB` reports with accessible URLs_
22+
23+
## Other changes (bug fixes, small refactors)
24+
25+
_Are there any small changes?_
26+
27+
## Notes
28+
29+
_Please note any questions, helps or contexts what maintainer(s) should know_

0 commit comments

Comments
 (0)