This is an automated email from the ASF dual-hosted git repository.
mthmulders pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-archetype.git
The following commit(s) were added to refs/heads/master by this push:
new e24ef2c5 Add PR template
e24ef2c5 is described below
commit e24ef2c53ad2f8cd42595e53e7e266a91cae3fcb
Author: Giovanni van der Schelde <[email protected]>
AuthorDate: Sat Oct 19 03:31:36 2024 +0200
Add PR template
Closes #233.
---
.github/pull_request_template.md | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..1bd467d6
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,26 @@
+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/ARCHETYPE) 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 `[ARCHETYPE-XXX] SUMMARY`,
+ where you replace `ARCHETYPE-XXX` and `SUMMARY` with the appropriate JIRA
issue.
+- [ ] Also format the first line of the commit message like `[ARCHETYPE-XXX]
SUMMARY`.
+ Best practice is to use the JIRA issue title in both 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.
+
+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
+please ask on the developers list.
+
+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).
