THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
1) file File JIRA ticket GEODE-nn on Apache JIRA. Note: JIRA automatically assigns the name GEODE-nn where nn is the actual the actual ticket number
2) assign Assign ticket to yourself (click "Assign to me" in JIRA). If you are not a committer, you will need to ask for JIRA 'contributor' permissions. Send an email to dev@geode.apache.org with your JIRA username requesting access.
3) change Change ticket status from OPEN to IN PROGRESS (click "Start Progress" in JIRA).
4) cd to geode checkout.
5) start Start the feature branch for GEODE-nn.
| Code Block |
|---|
git flow feature start GEODE-nn |
...
git checkout -b feature/GEODE-nn
6) work Work on the changes and tests for GEODE-nn (include GEODE-nn in commit messages). Commit messages should follow this format:
| No Format |
|---|
GEODE-nn: Capitalized, 50 chars or less summary More detailed explanation with linefeeds to wrap at 72 characters after a blank line following the summary. Further paragraphs come after blank lines. - Bullet points are okay, too (or *) - Typically a hyphen or asterisk is used for the bullet, followed by a single space, with blank lines in between, but conventions vary here - Use a hanging indent |
7) [optional] publish Publish the feature branch to share with others or other machine.
| Code Block |
|---|
git flow feature publish GEODE-nn |
Without git flow:
git push -u origin feature/GEODE-nn
8) [optional] access Access feature branch from other machine.
| Code Block |
|---|
git flow feature track GEODE-nn |
...
| Code Block |
|---|
git fetch git rebase origin/develop |
Long lived branches with many committers
| Code Block |
|---|
git fetch git merge origin/develop |
10) submit Submit review on Apache Reviews via the rbt command-line tool.
To setup rbt for your checkout, just run this once:
| Code Block |
|---|
git config reviewboard.url https://reviews.apache.org/ |
...
| Code Block |
|---|
rbt post --repository geode |
| Code Block |
|---|
git diff origin/develop...HEAD > GEODE-nn.diff |
click Click New Review Request.
- select "geode"
- click "Select" and choose diff file to upload
- fill in information (TODO)
- add group and users for review
- "publish" the review
12) update Update develop in local repository
| Code Block |
|---|
git checkout develop git pull --rebase |
13) finish Finish feature branch for GEODE-nn.
For a short lived feature branch with a few changes that you want to look like individual commits on develop (most branches should use this):
...
For a long lived branch where you want to see the merge history with develop:
| Code Block |
|---|
git flow feature finish --no-ff GEODE-nn |
Without git flow:
git checkout develop
git pull
git merge --no-ff feature/GEODE-nn
git branch -D feature/GEODE-nn
git push --delete origin feature/GEODE-nn
If you have done a bunch of merges from develop to your feature branch, but you still want to see only a single commit on develop, you can do a squash merge to develop:
| Code Block |
|---|
git flow feature finish -S GEODE-nn |
Without git flow:
git checkout develop
git pull
git merge --squash feature/GEODE-nn
git branch -D feature/GEODE-nn
git push --delete origin feature/GEODE-nn
14) pushPush your changes.
| Code Block |
|---|
git push |
15) change Change ticket status of GEODE-nn from IN PROGRESS to RESOLVED (click "Resolve Issue" and fill in details). Fill in the "Fixed in Version" to match the next release version. If you are not sure about what the next release version is, you can double check gradle.properties - the next version will be versionNumber.releaseType.