This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-pmd-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 342adcb Upgrade PR template for GitHub issues
342adcb is described below
commit 342adcbe75ff1e67c96287c7be25367e1c3af2c8
Author: Slawomir Jaranowski <s.jaranow...@gmail.com>
AuthorDate: Thu May 22 22:22:50 2025 +0200
Upgrade PR template for GitHub issues
---
.github/pull_request_template.md | 27 +++++++++++----------------
1 file changed, 11 insertions(+), 16 deletions(-)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 426fa49..51e18bc 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,19 +1,15 @@
Following this checklist to help us incorporate your
contribution quickly and easily:
- - [ ] Make sure there is a [JIRA
issue](https://issues.apache.org/jira/browse/MPMD) filed
- for the change (usually before you start working on it). Trivial
changes like typos do not
- require a JIRA issue. Your pull request should address just this
issue, without
- pulling in other changes.
- - [ ] Each commit in the pull request should have a meaningful subject line
and body.
- - [ ] Format the pull request title like `[MPMD-XXX] - Subject of the JIRA
Ticket`,
- where you replace `MPMD-XXX` with the appropriate JIRA issue. Best
practice
- is to use the JIRA issue title in the pull request title and in the
first line of the
- commit message.
- - [ ] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
- - [ ] Run `mvn clean verify` to make sure basic checks pass. A more thorough
check will
- be performed on your pull request automatically.
- - [ ] You have run the integration tests successfully (`mvn -Prun-its clean
verify`).
+- [ ] Your pull request should address just one issue, without pulling in
other changes.
+- [ ] Write a pull request description that is detailed enough to understand
what the pull request does, how, and why.
+- [ ] Each commit in the pull request should have a meaningful subject line
and body.
+ Note that commits might be squashed by a maintainer on merge.
+- [ ] Write unit tests that match behavioral changes, where the tests fail if
the changes to the runtime are not applied.
+ This may not always be possible but is a best-practice.
+- [ ] Run `mvn verify` to make sure basic checks pass.
+ A more thorough check will be performed on your pull request automatically.
+- [ ] You have run the integration tests successfully (`mvn -Prun-its verify`).
If your pull request is about ~20 lines of code you don't need to sign an
[Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
@@ -23,6 +19,5 @@ To make clear that you license your contribution under
the [Apache License Version 2.0, January
2004](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- - [ ] I hereby declare this contribution to be licenced under the [Apache
License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
-
- - [ ] In any other case, please file an [Apache Individual Contributor
License Agreement](https://www.apache.org/licenses/icla.pdf).
+- [ ] I hereby declare this contribution to be licenced under the [Apache
License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
+- [ ] In any other case, please file an [Apache Individual Contributor License
Agreement](https://www.apache.org/licenses/icla.pdf).
