Code contributions (draft)

When submitting patches to Apache Geode a contributor have pretty much two alternatives: GitHub or JIRA ticket with patch attached.
This document covers the steps for GitHub pull requests, but if a contributor decides to go JIRA + Attachement route the review step of this document should still apply.

GitHub

Fork the Apache Geode mirror project on github
```
 [img]
```
Clone your fork locally so you can actually start working.
```
 git clone https://github.com/markito/incubator-geode
```
After cloning add an upstream remote so your fork can actually reference the original Apache Geode repository.
```
 git remote add upstream https://github.com/apache/incubator-geode
```

Your git remote should look like the following:

 git remote -v
origin https://github.com/markito/incubator-geode (fetch)
origin https://github.com/markito/incubator-geode (push)
upstream github.com/apache/incubator-geode (fetch)
upstream github.com/apache/incubator-geode (push)

Fetch remote branches and checkout develop

 git fetch upstream
# update your local branch
git checkout develop

Geode follows git-flow conventions so if you do have git-flow installed in your system just do:
```
 git flow init
```

Then create your feature branch with the number of the JIRA task that describes your work (fix/feature).

 git flow feature start GEODE-41
Switched to a new branch 'feature/GEODE-41'
Summary of actions:
- A new branch 'feature/GEODE-41' was created, based on 'develop'
- You are now on branch 'feature/GEODE-41'
Now, start committing on your feature. When done, use:
git flow feature finish GEODE-41

Complete your work (commits) and in order to update the ticket with your progress use the following syntax in your commit messages:
```
 git commit -a -m "[GEODE-41] #comment My new cool feature XYZ"
```
Execute the precheckin gradle task in order to perform tests related to the components affected by your change. All tests must pass. When in doubt ask on @dev list.
```
 ./gradlew precheckin
```
When work is complete, consider whether documentation to be updated or created due to the new feature.
If/When needed to push your local work to GitHub use the following command:
```
 git push --set-upstream origin feature/GEODE-41
```
Open GitHub web inteface and you should see your just pushed branch with a 'Compare & pull request' button
This will lead to Open a pull request page with detailed information on which fork and branch you going from/to. You should add some descriptive information if needed and finally click on Create pull request
```
 [img]
```
The review process starts and once approved your PR will be merged into develop. if it's not approved or require some additional work, go back to the commit step.
Now you can go ahead and finish your feature
```
 git flow feature finish GEODE-41
```
Accepting the Pull-request
As a reviewer/committer do the review using GitHub or if needed request a ReviewBoard submission.
Once the PR is approved since the GitHub repository is a ready-only mirror you actually need to download the patch and apply. The JIRA ticket must have the link to the patch in the comments section, something like: https://github.com/apache/incubator-geode/pull/6.patch
Alternatively add GitHub as a remote to the ASF clone and just fetch pull requests. For example:

Clone the ASF git repository (if you haven't done yet)

 git clone https://git-wip-us.apache.org/repos/asf/incubator-geode.git

Add GitHub remote

 git remote add github https://github.com/apache/incubator-geode

(for local review) Fetch the pull request into a feature branch for review

 git fetch github pull/6/head:feature/GEODE-41
git checkout feature/GEODE-41
Where:
6 -> PR number
feature/GEODE-41 -> local destination branch

(for local review) After review is complete you can merge the feature into develop and remove the branch

 git flow feature finish GEODE-41 -F
Switched to branch 'develop'
Your branch is up-to-date with 'origin/develop'.
Updating f7af251..1f2e32a
Fast-forward
COMPILING.txt | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
Deleted branch feature/GEODE-41 (was 1f2e32a).
Summary of actions:
- The feature branch 'feature/GEODE-41' was merged into 'develop'
- Feature branch 'feature/GEODE-41' has been removed
- You are now on branch 'develop'

(if review was done through GitHub) Pull and squash the pull request
```
 git pull --squash github pull/6/head:feature/GEODE-41
```
Update the RELEASE notes file properly including the JIRA ticket number and the brief description about the feature/issue.

Commit the merge:

 git commit -a -m "[GEODE-41] (contributor-id via committer-asf-id) closes #6"
Where:
6 -> PR number
GEODE-41 -> JIRA number
contributor-id -> GitHub user handle
commiter-asf-id -> Committer ID accepting the PR

Finally push the repository.
```
 git push -f origin
```
Given the commit message with the PR number after the push the PR on GitHub will be closed and the JIRA ticket updated.
Rejecting PRs without committing
If reviewers or committers needs to close a PR if for instance, after proper evaluation it's something that won't get fixed it can be done through an empty commit message
```
git commit --allow-empty -m "Closes #6 *Won't fix*"
git push github develop
```

Space shortcuts

Page tree

GitHub

Accepting the Pull-request

Rejecting PRs without committing