[
https://issues.apache.org/jira/browse/PHOENIX-963?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13986073#comment-13986073
]
Gabriel Reid commented on PHOENIX-963:
--------------------------------------
I'm volunteering myself to handle writing this, but I think that one thing that
needs to be decided (or at least made known to me :-) is what the "preferred"
method of submitting patches is. It seems that GitHub pull requests are
currently used primarily -- do we want to stick with that as a part of the
"recommended" workflow for newcomers?
> 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)
