[uima-uimafit] 01/01: [UIMA-5810] Add contribution guidelines and PR template

[re...@apache.org]

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

rec pushed a commit to branch feature/UIMA-5810-Add-contribution-guidelines-and-PR-template-v3
in repository https://gitbox.apache.org/repos/asf/uima-uimafit.git

commit 1c9ec37d367eff162d216f14fefcf244b3f1cfcb
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Thu Aug 2 00:14:46 2018 +0200

    [UIMA-5810] Add contribution guidelines and PR template
    
    - Copied templates from master to the 3.0.x branch
---
 .github/CONTRIBUTING.md          | 40 ++++++++++++++++++++++++++++++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 74 insertions(+)

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..236c6de
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,40 @@
+# How to contribute to Apache UIMA uimaFIT
+
+Thank you for your intention to contribute to the Apache uimaFIT project. As an open-source 
+community, we highly appreciate external contributions to our project.
+
+To make the process smooth for the project *committers* (those who review and accept changes) and *contributors* (those who propose new changes via pull requests), there are a few rules to follow.
+
+## Contribution Guidelines
+
+Please check out the [How to get involved](https://uima.apache.org/get-involved.html) to understand how contributions are made. 
+A detailed list of coding standards can be found at [Apache UIMA Code Conventions](https://uima.apache.org/codeConventions.html) which also contains a list of coding guidelines that you should follow.
+For pull requests, there is a [check list](PULL_REQUEST_TEMPLATE.md) with criteria for acceptable contributions.
+
+## Preparing a Pull Request (PR)
+
+In order to contribute to a DKPro project, you need to create a **pull request**. This section
+briefly guides you through the best way of doing this:
+
+* Before creating a pull request, create an issue in the issue tracker of the project to which
+  you wish to contribute
+* Fork the project on GitHub
+* Create a branch based on the branch to which you wish to contribute. Normally, you should create
+  this branch from the **master** branch of the respective project. In the case you want to fix
+  a bug in the latest released version, you should consider to branch off the latest maintenance
+  branch (e.g. **2.4.x**). If you are not sure, ask via the issue you have just created. Do **not**
+  make changes directly to the master or maintenance branches in your fork. The name of the branch
+  should be e.g. `feature/UIMA-[ISSUE-NUMBER]-[SHORT-ISSUE-DESCRIPTION]` or `bugfix/UIMA-[ISSUE-NUMBER]-[SHORT-ISSUE-DESCRIPTION]`.
+* Now you make changes to your branch. When committing to your branch, use the format shown below
+  for your commit messages.
+```
+[UIMA-<ISSUE-NUMBER>] <ISSUE TITLE>
+<EMPTY LINE>
+- <CHANGE 1>
+- <CHANGE 2>
+- ...
+```
+* You can create the pull request any time after your first commit. I.e. you do not have to wait
+  until you are completely finished with your implementation. Creating a pull request early 
+  tells other developers that you are actively working on an issue and facilitates asking questions
+  about and discussing implementation details.
\ No newline at end of file
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..4610c13
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,34 @@
+<!--
+Thank you for contributing to Apache UIMA uimaFIT.
+
+In order to streamline the review of the contribution we ask you
+to ensure the following steps have been taken:
+-->
+
+**JIRA Ticket:** https://issues.apache.org/jira/browse/UIMA-XXXX
+
+### For all changes:
+- [ ] PR title starts with `[UIMA-XXXX]`.
+- [ ] Commit messages conform to the following format
+```
+[UIMA-<ISSUE-NUMBER>] <ISSUE TITLE>
+<EMPTY LINE>
+- <CHANGE 1>
+- <CHANGE 2>
+- ...
+```
+
+### For code changes:
+- [ ] PR includes new or updated tests related to the contribution.
+- [ ] PR includes new dependencies. Only dependencies under [approved licenses](http://www.apache.org/legal/resolved.html#category-a) are allowed.
+      LICENSE and NOTICE files in the respective modules where dependencies have been added as
+      well as in the project root have been updated.
+
+### For documentation related changes:
+- [ ] PDF and HTML versions of the documentation render ok.
+
+<!--
+### Note:
+Please ensure that once the PR is submitted, you check the Jenkins build status listed under 
+"Checks" in the PR for issues and submit an update to your PR as soon as possible.
+-->
\ No newline at end of file