Table of Contents | ||
---|---|---|
|
...
Fork the Apache Geode mirror project on GitHub - https://github.com/apache/geode
Clone the apache repository locally so you can start working:
Code Block git clone https://github.com/apache/geode
After cloning add your fork as an additional remote so you can push code to your fork. Substitute your GitHub username for 'markito' in this example, or use the GitHub 'HTTPS Clone URL':
Code Block cd geode git remote add myfork https://github.com/markito/geode
Your git remote should look like the following:
Code Block git remote -v origin https://github.com/apache/geode (fetch) origin https://github.com/apache/geode (push) myfork https://github.com/markito/geode (fetch) myfork https://github.com/markito/geode (push)
Create a local develop branch (develop is where all new development work goes).
Code Block git checkout develop
Then create your feature branch with the number of the JIRA task that describes your work (fix/feature). The You can call the branch whatever your want (it's your fork!) but the convention is to use feature/GEODE-XXX.
Code Block git checkout develop git pull git checkout -b feature/GEODE-41
Before committing and pushing your work, run the code formatter to format your code according to geode conventions
Code Block ./gradlew spA
Run any relevant tests and the basic build against your changes
Code Block ./gradlew build
Complete your work and commit itGeode follows git flow conventions. If you want, you can install the command line tool git flow to help you follow those conventions.Complete your work (commits) and in order to update the ticket with your progress.
Code Block git commit -a
Follow the guidelines for good commit messages. Here's an example:No Format GEODE-526: Fix oplog unit test race condition KRF files are created asynchronously. The test needs to wait for the files to be created before checking header content.
If you've modified source code, 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 the @dev list.
Code Block ./gradlew precheckin
- When work is complete, consider whether documentation needs to be updated or created due to the new feature.
If/When needed to push your local work to GitHub use the following command:
Code Block git push -u myfork feature/GEODE-41
- Open the GitHub web interface and you should see your just-pushed branch with a 'Compare & pull request' button:
This will lead to the 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 click on Create pull request. Once your PR is created, the CI system will run checks against your PR, which may take a couple of hours. You may want to create your PR as a draft PR so that you can see if your PR passes the checks before opening it up for review. All checks must pass before your PR can be merged.
The review process starts. Once approved, your PR will be need to be merged into develop. If it's not approved or requires some additional work, make changes and go back to the commit step.
Accepting a Pull-request
...
request
...
Accepting a PR Using the GitHub GUI
Once the PR is approved, if you are a committer, you can just merge the PR using the Merge button at the bottom of the pull request. Click the arrow next to the merge button and select the appropriate merge choice (Usually squash and merge to create a single commit on develop).
Accepting a PR Using the Command Line
If there are conflicts, our you would rather you can merge a PR from the command line.
(for local review) Fetch the pull request into a feature branch for review (Here's a neat trick to make this easier: https://gist.github.com/gnarf/5406589).
Code Block git fetch origin 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.
Code Block git checkout develop git merge feature/GEODE-41 git branch -d feature/GEODE-41
Review the changes and rebase if necessary to clean up and modify the history. If there are multiple commits, you may want to squash them together. Remember to add 'This closes #6' to the last commit message so that github will automatically close the PR. If the PR is comprised of just one commit, you can omit the rebase and simply add 'This closes #6' by using '
commit --amend
'.Code Block git log git rebase -i --> Append line "This closes #6" where #6 is the pull request id.
- Finally, push the commit to the origin repository.
Code Block |
---|
git push origin
|
...
Code Block |
---|
commit c562d3439577c0bf12cc0e39157761a8dd69da1f
Author: Dan Smith <dsmith@pivotal.io>
Commit: William Markito <wmarkito@pivotal.io> |
Rejecting PRs without committing
...
Website publishing
The Geode website is maintained as part of the repository, within the geode-site
directory. Instructions for updating the website are in the geode-site/website/README.md
file.