Repository: incubator-metron Updated Branches: refs/heads/master c793308cb -> 2c9299eec
METRON-755 Update GitHub PR Template closes apache/incubator-metron#471 Project: http://git-wip-us.apache.org/repos/asf/incubator-metron/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-metron/commit/2c9299ee Tree: http://git-wip-us.apache.org/repos/asf/incubator-metron/tree/2c9299ee Diff: http://git-wip-us.apache.org/repos/asf/incubator-metron/diff/2c9299ee Branch: refs/heads/master Commit: 2c9299eec1c4712425a2fc6d43337e0bdd8abbb2 Parents: c793308 Author: JonZeolla <zeo...@gmail.com> Authored: Thu Mar 9 13:52:41 2017 -0500 Committer: cstella <ceste...@gmail.com> Committed: Thu Mar 9 13:52:41 2017 -0500 ---------------------------------------------------------------------- .github/PULL_REQUEST_TEMPLATE.md | 38 +++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/2c9299ee/.github/PULL_REQUEST_TEMPLATE.md ---------------------------------------------------------------------- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d86305a..56ca8f3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,15 @@ -Thank you for submitting a contribution to Apache Metron (Incubating). -Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions. -Please refer also to our [Build Verification guildlines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides. +## Contributor Comments +[Please place any comments here. A description of the problem/enhancement, how to reproduce the issue, your testing methodology, etc.] -In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check -the following: +## Pull Request Checklist + +Thank you for submitting a contribution to Apache Metron (Incubating). +Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions. +Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides. + + +In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following: ### For all changes: - [ ] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel). @@ -16,25 +21,24 @@ the following: - [ ] Have you included steps to reproduce the behavior or problem that is being changed or addressed? - [ ] Have you included steps or a guide to how the change may be verified and tested manually? - [ ] Have you ensured that the full suite of tests and checks have been executed in the root incubating-metron folder via: - -``` -mvn -q clean integration-test install && build_utils/verify_licenses.sh -``` + ``` + mvn -q clean integration-test install && build_utils/verify_licenses.sh + ``` - [ ] Have you written or updated unit tests and or integration 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)? - [ ] Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent? ### For documentation related changes: -- [ ] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via site-book/target/site/index.html. - -``` -cd site-book -bin/generate-md.sh -mvn site:site +- [ ] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via `site-book/target/site/index.html`: -``` + ``` + cd site-book + bin/generate-md.sh + mvn site:site + ``` -### Note: +#### 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. It is also recommened that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request. +
