metron-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From o...@apache.org
Subject incubator-metron git commit: METRON-721 Add Github pull request template to help submitters and reviewers (ottobackwards) closes apache/incubator-metron#456
Date Fri, 17 Feb 2017 16:23:12 GMT
Repository: incubator-metron
Updated Branches:
  refs/heads/master d7147e32d -> 29646550c


METRON-721 Add Github pull request template to help submitters and reviewers (ottobackwards)
closes apache/incubator-metron#456


Project: http://git-wip-us.apache.org/repos/asf/incubator-metron/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-metron/commit/29646550
Tree: http://git-wip-us.apache.org/repos/asf/incubator-metron/tree/29646550
Diff: http://git-wip-us.apache.org/repos/asf/incubator-metron/diff/29646550

Branch: refs/heads/master
Commit: 29646550ce3b775668a4439b23677ad86a4dcf80
Parents: d7147e3
Author: ottobackwards <ottobackwards@gmail.com>
Authored: Fri Feb 17 10:38:41 2017 -0500
Committer: Otto Fowler <otto@apache.org>
Committed: Fri Feb 17 10:38:41 2017 -0500

----------------------------------------------------------------------
 .github/PULL_REQUEST_TEMPLATE.md | 40 +++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-metron/blob/29646550/.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..d86305a
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,40 @@
+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.
+
+
+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).

+- [ ] Does your PR title start with METRON-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)?
+
+
+### For code changes:
+- [ ] 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 
+```
+
+- [ ] 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
+
+```
+
+### 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.


Mime
View raw message