You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by ottobackwards <gi...@git.apache.org> on 2017/02/15 12:07:50 UTC
[GitHub] incubator-metron pull request #456: METRON-721 Add github pull request templ...
GitHub user ottobackwards opened a pull request:
https://github.com/apache/incubator-metron/pull/456
METRON-721 Add github pull request template to metron
The idea for this template is to hit some high level things to remind submitters of while referencing the comprehensive development guidelines document.
[Github templates](https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/) can only be picked up off of the main branch, so aside from checking the markdown formatting, I do not know what other testing can be done
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/ottobackwards/incubator-metron METRON-721
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-metron/pull/456.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #456
----
commit 3efd8e9af2fd141da8bdd48b019ce2fcebb01911
Author: Otto Fowler <ot...@gmail.com>
Date: 2017-02-15T12:03:49Z
add github pull request template
the idea for this template is to hit some high level things to remind submitters of
while referencing the comprehensive development guidelines document
we don't want this to be too large a document
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron pull request #456: METRON-721 Add github pull request templ...
Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/456#discussion_r101296484
--- Diff: .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
+
+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)?
+
+### 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?
+
+```
+cd site-book
+bin/generate-md.sh
+mvn site:site
+
+view changes via target/site/index.html
--- End diff --
Probably want to pull this out of the code block and into the above bullet. Maybe something like "(after generating the documentation using the below commands, review `site-book/target/site/index.html`)"
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #456: METRON-721 Add github pull request template to ...
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/incubator-metron/pull/456
Ok this isn't awesome work, Otto! I love this idea. I'll let it percolate for a bit but my +1 is imminent. :)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #456: METRON-721 Add github pull request template to ...
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/incubator-metron/pull/456
Yeah I think that a smoke test on vagrant is sufficient. A smoke test being that data flows through the topologies and into ES and is viewable by kibana.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #456: METRON-721 Add github pull request template to ...
Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:
https://github.com/apache/incubator-metron/pull/456
+1 from me by inspection.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron pull request #456: METRON-721 Add github pull request templ...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/456#discussion_r101297815
--- Diff: .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
+
+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)?
+
+### 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?
+
+```
+cd site-book
+bin/generate-md.sh
+mvn site:site
+
+view changes via target/site/index.html
--- End diff --
done
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #456: METRON-721 Add github pull request template to ...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/incubator-metron/pull/456
So - why don't we come up with a cut down version of that, maybe restricted to trying quick or full dev? or reference and link like we do with the full dev guide?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #456: METRON-721 Add github pull request template to ...
Posted by jjmeyer0 <gi...@git.apache.org>.
Github user jjmeyer0 commented on the issue:
https://github.com/apache/incubator-metron/pull/456
Oh, absolutely. Sorry, I didn't mean to suggest to add the whole page. I just meant a check box that says something like: Have verified building and running locally by creating `full-dev` environment.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #456: METRON-721 Add github pull request template to ...
Posted by jjmeyer0 <gi...@git.apache.org>.
Github user jjmeyer0 commented on the issue:
https://github.com/apache/incubator-metron/pull/456
@ottobackwards looks good to me. Again, great idea. I think it's ready to be merged.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #456: METRON-721 Add github pull request template to ...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/incubator-metron/pull/456
Thanks for the review!
I am not sure about verifying builds. I don't think we should put everything that is in the Dev Guide or the Verification in the PR template, there is some balance to be had there. I don't think we expect every PR to have validated the builds anyways.
I did make the jira change.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #456: METRON-721 Add github pull request template to ...
Posted by jjmeyer0 <gi...@git.apache.org>.
Github user jjmeyer0 commented on the issue:
https://github.com/apache/incubator-metron/pull/456
Also, what do you think about adding a check box for verifying builds? https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #456: METRON-721 Add github pull request template to ...
Posted by jjmeyer0 <gi...@git.apache.org>.
Github user jjmeyer0 commented on the issue:
https://github.com/apache/incubator-metron/pull/456
I agree it shouldn't be a duplicate of the dev guide. My thought on the verify builds was that quite a few PRs state they've done it. That being said, I'm not hung up on it. I'll defer to you. Other than that, I agree this is a great idea, and looks good.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron pull request #456: METRON-721 Add github pull request templ...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-metron/pull/456
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron pull request #456: METRON-721 Add github pull request templ...
Posted by jjmeyer0 <gi...@git.apache.org>.
Github user jjmeyer0 commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/456#discussion_r101286501
--- Diff: .github/PULL_REQUEST_TEMPLATE.md ---
@@ -0,0 +1,37 @@
+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
+
+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?
--- End diff --
In our dev guide it gives directions to create one if a Jira doesn't exist. Do you think it makes sense for these to match?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-metron issue #456: METRON-721 Add github pull request template to ...
Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:
https://github.com/apache/incubator-metron/pull/456
I put a reference to the verification doc at the top ' for smoke test guide ' and then put a checkbox for running in vagrant - how's that?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---