You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@unomi.apache.org by sh...@apache.org on 2021/02/15 14:08:54 UTC

[unomi] 01/01: UNOMI-431 Add initial proposal for PR template

This is an automated email from the ASF dual-hosted git repository.

shuber pushed a commit to branch UNOMI-431-github-pr-tempate
in repository https://gitbox.apache.org/repos/asf/unomi.git

commit d7468188f513b75dac6b0fd62fd24ecae36a4fb1
Author: Serge Huber <sh...@jahia.com>
AuthorDate: Mon Feb 15 15:08:42 2021 +0100

    UNOMI-431 Add initial proposal for PR template
---
 .github/pull_request_template.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..baf963d
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,33 @@
+PR Title format: 
+
+    [UNOMI-XXX] Pull request title with JIRA reference
+
+**Please** add a meaningful description for your change here
+
+----
+
+**Please** 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/UNOMI) 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.
+ - [ ] Format the pull request title like `[UNOMI-XXX] - Title of the pull request`
+ - [ ] Provide integration tests for your changes, especially if you are changing the behavior of existing code or adding
+       significant new parts of code.
+ - [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why. 
+       Copy the description to the related JIRA issue
+ - [ ] Run `mvn clean install -P integration-tests` to make sure basic checks pass. A more thorough check will be 
+        performed on your pull request automatically.
+ 
+Trivial changes like typos do not require a JIRA issue (javadoc, project build changes, small doc changes, comments...). 
+ 
+If this is your first contribution, you have to read the [Contribution Guidelines](https://unomi.apache.org/contribute.html)
+
+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).