phoenix-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gabriel Reid (JIRA)" <>
Subject [jira] [Commented] (PHOENIX-963) Add a description of how to contribute
Date Thu, 01 May 2014 16:19:15 GMT


Gabriel Reid commented on PHOENIX-963:

Thanks for the links to previous discussions on this, I hadn't seen it yet.

I'm definitely on board with the idea of not dictating process too much (or being too caught
up in process). My idea is more about giving people a push in the right direction to answer
the question of "how do I contribute" than saying how things really have to be done.

As the general process in the doc (and being pretty much in line with what other ASF projects
that I'm familiar with propose):
* Open a discussion on the dev list if it's a major change that may warrant discussion up
* Create a JIRA ticket
* Add a patch file (with general directions on how to do this), or open a PR on GitHub (in
line with what the jclouds wiki says)

Sound good?

> Add a description of how to contribute
> --------------------------------------
>                 Key: PHOENIX-963
>                 URL:
>             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

View raw message