Skip to content

Commit f777024

Browse files
committed
chore: Convert PR template instructions into comments
- Move instructional text into HTML comments to avoid manual deletion - Improve clarity and structure of the PR template Signed-off-by: Omar <omar.brbutovic@secomind.com>
1 parent a9f6121 commit f777024

File tree

1 file changed

+34
-12
lines changed

1 file changed

+34
-12
lines changed

.github/pull_request_template.md

Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,41 @@
1-
## [ Change title ]
1+
## Change Title
2+
3+
<!--
24
Describe the big picture of your changes here to communicate to the maintainers
3-
why we should accept this pull request. If it fixes a bug or resolves a feature
4-
request, be sure to link to that issue.
5+
why we should accept this pull request.
6+
7+
If it fixes a bug or resolves a feature request, be sure to link to the related issue.
8+
Example:
9+
- Fixes #123
10+
-->
511

612
## Checklist
7-
_Put an `x` in the boxes that apply. You can also fill these out after creating
8-
the PR. If you're unsure about any of them, don't hesitate to ask. We're here to
9-
help! This is simply a reminder of what we are going to look for before merging
10-
your code._
13+
14+
<!--
15+
Put an `x` in the boxes that apply. You can fill these out after creating the PR.
16+
If you're unsure about any of them, don't hesitate to ask.
17+
This is simply a reminder of what will be checked before merging.
18+
-->
1119

1220
- [ ] I have read the CONTRIBUTING.md
1321
- [ ] I have added tests that prove my fix is effective or that my feature works
14-
- [ ] I have added necessary documentation (if appropriate)
22+
- [ ] I have added or updated documentation (if appropriate)
23+
24+
## Further Comments (optional)
25+
26+
<!--
27+
If this is a relatively large or complex change, explain:
28+
- Why you chose this solution
29+
- What alternatives you considered
30+
- Any trade-offs or follow-up work
31+
-->
32+
33+
## Screenshots / Demos (optional)
34+
35+
<!--
36+
If this PR introduces visual or UI changes, it is highly appreciated to include
37+
screenshots, GIFs, or a short video.
1538
16-
## Further comments (optional)
17-
If this is a relatively large or complex change, kick off the discussion by
18-
explaining why you chose the solution you did and what alternatives you
19-
considered, etc...
39+
This helps reviewers more easily understand the changes and makes it simpler to
40+
track visual differences over time.
41+
-->

0 commit comments

Comments
 (0)