GitHub user justinleet opened a pull request:
https://github.com/apache/metron/pull/881
METRON-1071: Create CONTRIBUTING.md
## Contributor Comments
Totally forgot I'd been sitting on a half done version of this. It's
basically a stripped down version of the Development Guidelines to make it more
obvious how to commit. Honestly, I'd rather help people out in the
contributing phase than for the initial ask to be seeing if our dev guidelines
can be read faster than Les Miserables.
Let me know how we want to adjust this, if this is the right level of
detail, etc.
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
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:
- [x] 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).
- [x] 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.
- [x] Has your PR been rebased against the latest commit within the target
branch (typically master)?
### For documentation related changes:
- [x] 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
mvn 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 recommended 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.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/justinleet/metron contributing
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/881.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 #881
----
commit 676cc6a076b9858a34b659e8cad557552363029c
Author: justinjleet <justinjleet@...>
Date: 2017-07-29T12:04:14Z
Initial contributing
----
---
