Skip to content

Commit 4abc0b3

Browse files
update(issue-template): created an issue template (#11)
2 parents 4f67049 + d741ba0 commit 4abc0b3

File tree

2 files changed

+50
-8
lines changed

2 files changed

+50
-8
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### ISSUE SUMMARY
2+
3+
`the-issue-summary-goes-here`
4+
5+
### ACCEPTANCE CRITERION
6+
7+
-
8+
-
9+
-
10+
11+
### FOLDER TO WORK ON
12+
13+
<hr>
14+
15+
#### OUR BRANCH NAMING CONVERSION AND COMMIT MESSAGES
16+
17+
| CONTRIBUTOR | BRANCH NAME | COMMIT |
18+
| ----------- | ----------- | ------ |
19+
| @ | `/` | `:` |

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,42 @@
1-
#### PULL REQUEST SUMMARY
1+
### PULL REQUEST SUMMARY
22

33
`Briefly explain the purpose of this pull request.`
44

5-
#### CHANGES MADE
5+
<hr>
66

7-
- List key changes made in this PR.
7+
#### FILES THAT ARE WORKED ON
88

9-
#### RELATED ISSUES
9+
| FILES TOUCHED | UPDATED ANY EXSISTING CODE | WRITTEN SOMETHING NEW |
10+
| --------------------- | -------------------------- | --------------------- |
11+
| `file-name-goes-here` | `yes/no` | `yes/no` |
1012

11-
- Reference any related issue (e.g., fixes #123).
13+
<hr>
1214

13-
#### PROVIDE SCREENSHOTS OR VIDEO
15+
#### ANY ISSUES WORKED ON
1416

15-
Include relevant screenshots if applicable.
17+
| ISSUE | ISSUE LINK |
18+
| ----- | ----------------------- |
19+
| `#99` | `url-from-kanban-board` |
20+
21+
<hr>
22+
23+
#### PROVIDE EVIDANCE OF WORK
24+
25+
Include relevant screenshots / video if applicable.
26+
27+
<hr>
1628

1729
#### ADDITIONAL NOTE FOR RUNNING LOCALLY
1830

19-
`Any additional context or considerations?`
31+
| MESSAGE | PACKAGES INSTALLED | COMMAND TO INSTALL |
32+
| ------------------------ | ------------------ | ----------------------------- |
33+
| `your-message-goes-here` | `yes/no` | `npm install or bun install` |
34+
35+
<hr>
36+
37+
#### GIT FOLLOW UPS
38+
39+
| COMMAND | EFFECT |
40+
| ----------------------- | ------------------------------------------------------------------------------ |
41+
| `git pull main` | `Checkout to the main branch, this will up-to-date your local with remote` |
42+
| `git merge origin/main` | `Merges all the up-to-date changes of your local main to local feature branch` |

0 commit comments

Comments
 (0)