You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@metron.apache.org by jo...@apache.org on 2018/10/16 16:48:59 UTC
metron-bro-plugin-kafka git commit: METRON-1828 Improve bro plugin
contributing documentation (JonZeolla) closes
apache/metron-bro-plugin-kafka#14
Repository: metron-bro-plugin-kafka
Updated Branches:
refs/heads/master 0fd459454 -> 0883c53e0
METRON-1828 Improve bro plugin contributing documentation (JonZeolla) closes apache/metron-bro-plugin-kafka#14
Project: http://git-wip-us.apache.org/repos/asf/metron-bro-plugin-kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/metron-bro-plugin-kafka/commit/0883c53e
Tree: http://git-wip-us.apache.org/repos/asf/metron-bro-plugin-kafka/tree/0883c53e
Diff: http://git-wip-us.apache.org/repos/asf/metron-bro-plugin-kafka/diff/0883c53e
Branch: refs/heads/master
Commit: 0883c53e09214c9533fc7dc96c9f33cc1a1202ec
Parents: 0fd4594
Author: JonZeolla <ze...@gmail.com>
Authored: Tue Oct 16 12:48:32 2018 -0400
Committer: jonzeolla <jo...@apache.org>
Committed: Tue Oct 16 12:48:32 2018 -0400
----------------------------------------------------------------------
.github/PULL_REQUEST_TEMPLATE.md | 26 ++++++++++++++++++++++++++
README.md | 6 ++++++
2 files changed, 32 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/metron-bro-plugin-kafka/blob/0883c53e/.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..c001a7b
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,26 @@
+## Contributor Comments
+[Please place any comments here. A description of the problem/enhancement, how to reproduce the issue, your testing methodology, etc.]
+
+
+## Pull Request Checklist
+
+Thank you for submitting a contribution to Apache Metron's Bro kafka writer plugin.
+
+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 via:
+ ```
+ bro-pkg test $GITHUB_USERNAME/metron-bro-plugin-kafka --version $BRANCH
+ ```
+- [ ] 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 Apache Metron's [Vagrant full-dev environment](https://github.com/apache/metron/tree/master/metron-deployment/development/centos6) or the equivalent?
+
http://git-wip-us.apache.org/repos/asf/metron-bro-plugin-kafka/blob/0883c53e/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 91b6e1b..90d8444 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@ This software is a part of the [Apache Metron](http://metron.apache.org/) projec
* [Activation](#activation)
* [Settings](#settings)
* [Kerberos](#kerberos)
+* [Contributing](#contributing)
## Installation
@@ -262,3 +263,8 @@ redef Kafka::kafka_conf = table( ["metadata.broker.list"] = "node1:6667"
, ["sasl.kerberos.principal"] = "metron@EXAMPLE.COM"
);
```
+
+## Contributing
+
+If you are interested in contributing to this plugin, please see the Apache Metron [CONTRIBUTING.md](https://github.com/apache/metron/blob/master/CONTRIBUTING.md).
+