#UML Notation
Class name - bold, capital camel case
Variables - [-, +, #, ~] "Name" : "Data type" (camel case)
Method/Function - [-, +, #, ~] "Name"( arg1:"Data type",..., argN:"Data type" ) : "Return type" (camel case)
Static type - Underlined, camel case
Constant type - ALL CAPS
#Git Standards
##When starting a new task/branch:
- Make a branch from dev:
git checkout -b t_<Branch Name> dev
- Do work on branch
- Make a commit:
git commit -a
##To backup your branch:
- Save on remote:
git push -u origin t_<Branch Name>
- To check if it saved your branch to the remote repo:
git branch -a
- It will say:
remotes/origin/t_<Branch Name>
##For testing:
###Your branch locally with dev:
git pull --rebase origin dev
- If merging conflict(s) occur(s), See To merge conflicts
- Start testing
###Your branch with others:
####One person resets tempdev:
- git push origin +dev:tempdev
- Others wait until this is done
####Everyone participating in the test, merges their branch into tempdev:
git checkout tempdev
git pull
git merge t_<Branch Name>
git push origin tempdev
- Wait until everyone in the test has pushed
git pull origin tempdev
- Start test
##Done with task/branch, ready to merge into dev:
git checkout t_<Branch Name>
git pull --rebase origin dev
git checkout dev
git merge t_<Branch Name>
git push origin dev
##Destroy backup copy on remote of your branch:
git push origin :t_<Branch Name>
##Destroy local copy:
- Make sure you are on a different branch then the one you will be deleting:
git status
- If on that branch:
git checkout <Other Branch>
git branch -d t_<Branch Name>
Your branch will still exist in history forever, so don't fret your little nickers, child.
##Merge well tested dev into master (remember, master must always be working):
git pull
git checkout master
git merge dev
git push origin master
- See which files have conflicts:
git status
- Open file(s) and delete and/or combine correct pieces of code between <<<< HEAD to === then to >>>>
git add <File Name>
- If More files to merge repeat from step 2
git rebase --continue
Git tags are for annotating releases and stuff