[
https://issues.apache.org/jira/browse/PHOENIX-963?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14007444#comment-14007444
]
James Taylor commented on PHOENIX-963:
--------------------------------------
I like the description below from [~apurtell] on avoiding the push of merge
commits upstream. How about we add this to our "How to Contribute" section?
From: Andrew Purtell <[email protected]>
Date: Fri, May 23, 2014 at 10:38 AM
Subject: [DISCUSSION] Avoiding merge commits
To: "[email protected]" <[email protected]>
I recommend we do not push merge commits upstream. I suppose it is easy enough
to filter them out when looking at history but there is no need to be merging
upstream branches into your local tracking branch when you can rebase instead.
In this way we can avoid polluting the history in the master repository with
unnecessary merge commit entries. (And maybe some devs will be merging upstream
into tracking branches or merging commits from local feature branches several
times per day, and these will all accumulate...)
When updating your local tracking branch from upstream, use git fetch upstream
&& git rebase upstream/branch instead of 'git merge'.
When developing features on a local branch it's possible to do a squash commit
from the feature branch to the tracking branch using 'git rebase' instead of
'git merge', then a push of the single squashed commit from the tracking branch
to the upstream branch.
If these workflow choices are acceptable by consensus we can update the 'how to
commit' document with an illustration of the workflow with example commands.
> 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)
