[jira] [Commented] (PHOENIX-963) Add a description of how to contribute

["James Taylor (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/PHOENIX-963?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13986233#comment-13986233 ] 

James Taylor commented on PHOENIX-963:
--------------------------------------

Thanks, [~gabriel.reid]. +1. We discussed part of this (the "how to create and upload a patch") a while back (maybe before your time) here: http://mail-archives.apache.org/mod_mbox/incubator-phoenix-dev/201401.mbox/%3CCAAF1Jdh_N8=uoye_wCye43g77ktbVYBOvKbyzN2F+Y5=SksRVw@mail.gmail.com%3E

I like the the methodology jcloud uses: http://wiki.apache.org/jclouds/Committers%20Guide, but others made the valid point that we shouldn't dictate process too much, so for "lighter" patches, attaching a .patch file is good.

We have an eclipse prefs file, an import order file, and a code template checked in at phoenix/dev. I prefer to have no warnings too (from Eclipse), but this is broken in 4.0 (which I've been meaning to fix). The generated protobuf code has a bunch of warnings - was thinking to add top level suppresses for these and fix (or suppress) any other warning.

> Add a description of how to contribute
> --------------------------------------
>
>                 Key: PHOENIX-963
>                 URL: https://issues.apache.org/jira/browse/PHOENIX-963
>             Project: Phoenix
>          Issue Type: Improvement
>            Reporter: Gabriel Reid
>
> There is currently no clear description of how to create and submit patches to Phoenix, with a number of options for creating and submitting patches (e.g. GitHub PR, Jira with git diff, Jira with git am). Also, while many users are familiar with working with GitHub pull requests, there are many who are less familiar with manually generating patches with git.
> A page should be added to the Phoenix website describing the (recommended) workflow to be followed when developing and submitting a patch to Phoenix. This should include an explanation of at least the following:
> * how to check out the code
> * recommendations on unit tests (e.g. where to locate unit and integration tests)
> * code style requirements
> * how to create and upload a patch
> Although these are things that are basic knowledge for many (and are repeated on many ASF project websites), it can be useful for newcomers who either don't know some of these details, or want to make sure they're doing things in line with expectations.



--
This message was sent by Atlassian JIRA
(v6.2#6252)