OPENNLP-995: Add a PR Review Template for contributors
Project: http://git-wip-us.apache.org/repos/asf/opennlp/repo Commit: http://git-wip-us.apache.org/repos/asf/opennlp/commit/c2b055fa Tree: http://git-wip-us.apache.org/repos/asf/opennlp/tree/c2b055fa Diff: http://git-wip-us.apache.org/repos/asf/opennlp/diff/c2b055fa Branch: refs/heads/parser_regression Commit: c2b055facd4f7504b806c7b7231dfef14ef73a7f Parents: e1a1e1d Author: smarthi <[email protected]> Authored: Thu Feb 23 07:46:17 2017 -0500 Committer: Jörn Kottmann <[email protected]> Committed: Thu Apr 20 12:40:21 2017 +0200 ---------------------------------------------------------------------- .github/CONTRIBUTING.md | 11 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 27 +++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/opennlp/blob/c2b055fa/.github/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..577eb16 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# How to contribute to Apache OpenNLP + +Thank you for your intention to contribute to the Apache OpenNLP 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](http://opennlp.apache.org/get-involved.html) to understand how contributions are made. +A detailed list of coding standards can be found at [Apache OpenNLP Code Conventions](http://opennlp.apache.org/code-conventions.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. http://git-wip-us.apache.org/repos/asf/opennlp/blob/c2b055fa/.github/PULL_REQUEST_TEMPLATE.md ---------------------------------------------------------------------- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..579e2e0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +Thank you for contributing to Apache OpenNLP. + +In order to streamline the review of the contribution we ask you +to ensure the following steps have been taken: + +### For all changes: +- [ ] Is there a JIRA ticket associated with this PR? Is it referenced + in the commit message? + +- [ ] Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character. + +- [ ] Has your PR been rebased against the latest commit within the target branch (typically master)? + +- [ ] Is your initial contribution a single, squashed commit? + +### For code changes: +- [ ] Have you ensured that the full suite of tests is executed via mvn clean install at the root opennlp folder? +- [ ] Have you written or updated unit tests to verify your changes? +- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)? +- [ ] If applicable, have you updated the LICENSE file, including the main LICENSE file in opennlp folder? +- [ ] If applicable, have you updated the NOTICE file, including the main NOTICE file found in opennlp folder? + +### For documentation related changes: +- [ ] Have you ensured that format looks appropriate for the output in which it is rendered? + +### Note: +Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
