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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Tip: Commit often, perfect later.
|
- 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.