Skip to content

Commit 6c35797

Browse files
authored
Merge pull request #284 from Guts/tooling/add-pr-template
add(tooling): pull request template aligned with the QGIS project
2 parents 50679f7 + 42e13b0 commit 6c35797

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<!-- Thanks for your contribution to QGIS! Please make sure you read the following guidelines before opening a pull request. -->
2+
3+
## Description
4+
5+
[Replace this with some text explaining the rationale and details about this pull request]
6+
7+
## Author's checklist
8+
9+
- [ ] I have read the [contributing guidelines](https://github.com/qgis/QGIS-Plugins-Website/blob/master/CONTRIBUTING.md) and my pull request follows them.
10+
- [ ] my commits tend to comply with [Conventional Commits](https://www.conventionalcommits.org/); so they are descriptive and explain the rationale for changes. Messages and description are self-explanatory to make the git log a readable story of the project.
11+
- [ ] I have added tests that prove my fix is effective or that my feature works.
12+
- [ ] I have added necessary documentation (if appropriate).
13+
- [ ] commits which fix bugs include `Fixes #11111` at the bottom of the commit message.
14+
15+
> [!TIP]
16+
> If you forgot to do this, don't be shy and write the same statement into this text field with the pull request description.
17+
18+
### AI tool usage
19+
20+
- [ ] AI tool(s) (Copilot, Claude, or something similar) supported my development of this PR. See our [policy about AI tool use](https://github.com/qgis/QGIS-Enhancement-Proposals/blob/master/qep-408-ai-tool-policy.md). Use of AI tools *must* be indicated. Failure to be honest might result in banning.
21+
22+
<!--
23+
**BEFORE HITTING SUBMIT** -- Please SPIN UP THE DOCKERIZED PROJECT AND TEST your changes thoroughly. This is YOUR responsibility! Do NOT rely on the project maintainers to do this for you!
24+
25+
IMPORTANT NOTES FOR FIRST TIME CONTRIBUTORS
26+
===========================================
27+
28+
Congratulations, you are about to make a pull request to QGIS or one of its related project! To make this as easy and pleasurable for everyone, please take the time to read these lines before opening the pull request.
29+
30+
Include a few sentences describing the overall goals for this pull request (PR). If applicable also add screenshots or - even better - screencasts.
31+
Include both: *what* you changed and *why* you changed it.
32+
33+
If this is a pull request that adds new functionality which needs documentation, give an especially detailed explanation.
34+
In this case, start with a short abstract and then write some text that can be copied 1:1 to the documentation in the best case.
35+
36+
37+
----
38+
39+
Reviewing is a process done by project maintainers, mostly on a volunteer basis. We try to keep the overhead as small as possible and appreciate if you help us to do so by checking the following list.
40+
Feel free to ask in a comment if you have troubles with any of them.
41+
42+
- Commit messages are descriptive and explain the rationale for changes.
43+
44+
- Commits which fix bugs include `Fixes #11111` at the bottom of the commit message. If this is your first pull request and you forgot to do this, write the same statement into this text field with the pull request description.
45+
46+
- New unit tests have been added for relevant changes
47+
48+
- you have read and acknowledged [the contributing guidelines](https://github.com/qgis/QGIS-Plugins-Website?tab=contributing-ov-file) and your PR complies with
49+
-->
50+
51+
## Reviewer's checklist
52+
53+
- [ ] I remember to check the "Author's checklist" above and ask the author to update the PR description if any of the items are not checked.
54+
- [ ] I remember that welcoming new contributors is more important than nitpicking on code style. I will be kind and respectful in my review comments.

0 commit comments

Comments
 (0)