Skip to content

Commit 97df5a3

Browse files
committed
feat: pull request template
1 parent 134882b commit 97df5a3

2 files changed

Lines changed: 39 additions & 2 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!--
2+
Hello 👋 Thank you for submitting a pull request.
3+
4+
To help us merge your PR, make sure to follow the instructions below:
5+
6+
- Create or update the documentation. (Should be made against the `main` branch)
7+
- Create or update the tests.
8+
- Refer to the issue you are closing in the PR description - fix #issue
9+
- Specify if the PR is in WIP (work in progress) state or ready to be merged
10+
11+
Please ensure you read through the Contributing Guide:
12+
https://github.com/joschan21/profanity.dev/blob/main/CONTRIBUTING.md
13+
-->
14+
15+
## Description
16+
17+
Describe the technical changes you did.
18+
19+
## Why is it needed?
20+
21+
Describe the issue you are solving.
22+
23+
## Screenshot or GIFs (if applicable)
24+
25+
If the changes include visual modifications, include screenshots or GIFs to demonstrate the before and after effects.
26+
27+
## Testing
28+
29+
Describe the testing strategy employed for this PR, including any manual or automated tests conducted. Specify the testing environment and provide clear instructions for reviewers on how to reproduce the tests, if applicable.
30+
31+
## Related issue(s)/PR(s)
32+
33+
Let us know if this is related to any issue/pull request
34+
35+
## Additional Notes
36+
37+
Include any additional information or context that may be helpful for reviewers.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828

2929
```sh
3030
└── profanity.dev/
31-
├── tensor-api # Hono server
32-
├── vector-api # Hono server
31+
├── tensor-api # Hono serverless api
32+
├── vector-api # Hono serverless api
3333
└── www # NextJs application
3434
```
3535

0 commit comments

Comments
 (0)