Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
The branch where development work takes place is the master.
Set up your Git environment (for first-time contributors):
- Make sure you have your basic Git environment set up.
Choose a bug:
- Find a bug or feature you like; nail down your JIRA ticket; if necessary, file it in JIRA.
Design phase:
If you are developing a feature, or you are working on a bug that involves an interface change, you'll need to go through the design phase.
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Development cycle:
Update your (forked & locally cloned) repository's master branch with the golden repository's master (IMPORTANT: Your fork's master branch should not be touched with any of your development changes. It should just reflect the golden repository's master, exactly).Anchor UpdateFork UpdateFork
Info | ||
---|---|---|
| ||
git checkout master git pull upstream master |
- Create a development branch for the ticket that you would like to work on and name it with the JIRA ID of the ticket:
Excerpt | ||||||||
---|---|---|---|---|---|---|---|---|
Insert excerpt | | Coding | Coding | |||||
icon | false | nopanel | true
Anchor | ||||
---|---|---|---|---|
|
Develop Your Code and Your Tests
We recommend developing your code and your tests in parallel. Your PTL tests should provide good coverage of the requirements and your design.
Anchor | ||||
---|---|---|---|---|
|
Put License Text in Headers for Code and Tests
If you create new source or test files, make sure that this license text is in the header for all code and test files.
Anchor | ||||
---|---|---|---|---|
|
Get Approval for Your Code and Tests
Your code is ready to commit when the following are true:
- The code adheres to our coding standards
- You have approval from two people: one maintainer and one other contributor (who can be a maintainer); approvals must be posted in the development forum, not the wiki
- Complete the development on your newly created branch.
Commit changes in the updated file to your branch with a good commit message. Make your commit message relevant and concise, so that it will be helpful to you later:
Info icon false git add <updated file>
git commit -m "<Commit message>"
Tip: Commit often, perfect later.
- Push the development branch to your fork. By convention, 'origin' points to your forked repository on GitHub:
Info | ||
---|---|---|
| ||
git push origin <JIRA ID> |
- Repeat the above steps until you are satisfied with your code change.
Fetch changes made to the golden repository by other contributors. By convention, 'upstream' points to the golden repository on GitHub:
Info icon false git fetch upstream
Rebase your development branch with new changes from the golden repository's master. 'upstream/master' is the remote tracking branch for the golden repository's (upstream's) master branch, on your local machine:
Info icon false git checkout <JIRA ID>
git rebase upstream/master
- If there are conflicts, Git will throw an error message informing you so and ask you to resolve it before continuing the rebase.
- Resolve conflicts the same way you resolve an ordinary merge conflict in Git. Here's a way to resolve conflicts from the command line.
Then, just continue the rebase operation:
Info icon false git rebase --continue
If the conflict is complex or problematic, you can abort the current rebase operation instead of continuing, and come back to it later:
Info icon false git rebase --abort
- After the rebase is complete, you might want to clean up your branch's commit history:
Squash all your commits into fewer, meaningful change commits (just one suffices if the code change is small enough).
Info icon false git checkout <JIRA ID>
git rebase -i --fork-point master
Write meaningful commit messages for your commits while doing the squash above. You can also use git commit --amend or rebase if you'd rather do it later.
Finally, push the polished branch to your fork. Because you did a git rebase, you'll need to do a force push.
Info icon false git push -f origin <JIRA ID>
- Look at the checklist for developing code.
- Your code changes are good to go! Go ahead and create a pull request.
- Your changes are now ready to be reviewed.
Review and check-in:
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
Cleanup:
Housekeeping: we strongly recommend that you delete the development branch from your forked and cloned repos now.
Info icon false git checkout master
git push origin --delete <JIRA ID> (deletes <JIRA ID>from the fork)
git branch -D <JIRA ID>(deletes <JIRA ID>from local clone)
- Update your bug.