[jira] [Commented] (OPENNLP-1045) Add documentation for development with Git (at ASF, GitHub, etc) for OpenNLP

["Bruno P. Kinoshita (JIRA)" <ji...@apache.org>]

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

Bruno P. Kinoshita commented on OPENNLP-1045:
---------------------------------------------

Lesson from tonight's mess in opennlp-site :-)

{noformat}
Add a section for merging pull requests. Developers should be instructed to either set up (local/globally) fast-forward mode on.

git config --global merge.ff only
git config merge.ff only

Or remember to use --ff-only when merging pull requests.

Also, before submitting, developers can amend the commit message, adding the foot note "This closes #1234" where 1234 is the pull request number. In case the developer forgets to amend the commit, and he is the author of the pull request, he can still close in the GitHub UI. Alternatively, the developer should ask the user, and wait a while to close the pull request. The last option is to send an empty commit.
{noformat}

> Add documentation for development with Git (at ASF, GitHub, etc) for OpenNLP
> ----------------------------------------------------------------------------
>
>                 Key: OPENNLP-1045
>                 URL: https://issues.apache.org/jira/browse/OPENNLP-1045
>             Project: OpenNLP
>          Issue Type: Documentation
>          Components: Website
>            Reporter: Bruno P. Kinoshita
>            Priority: Minor
>              Labels: development, documentation, git, website
>
> We need to add documentation for developers, explaining the process to work with Git in Apache OpenNLP.
> Listing things like proper way to commit (e.g. include JIRA issue whenever possible in the commit message), how to handle and merge pull requests (e.g. empty commits, merge with fast-forward, etc), and so it goes.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)