154
edits
Changes
→Common actions for school projects
=Common actions for school projects=
==Kick-start a project (project initiation)==
# create a directory to do hold your work# checkout the entire repository (the whole thing) into the that directory#: Look and make sure that you have the 3 directories (branches, tags, trunk)# Open the branches directory and create a sub-directory using your login name#: this becomes the root of your own (each students') workshop
#: ''' note: do not use the operating system's file management to copy, move, etc any of the '''''versioned''''' files
# Do an update on the whole repo to see all of the changes from all students# branch the trunk into a sub-dir of your workshop (name the this sub-dir using with your assigned task)#: the verb branch as verb, means copy (in the repository)You are good to go to - you can start working on your repositorytask
==Start working on a project (Start a task)==
# If you have not already branched the trunk:#: branch/tag the trunk into a sub-directoryunderwyour workshop. Use your task name/description to Name this sub-directory so you can refer to it easily later.# In do your work within your branch/task directory do your work and commit anytime you have something worth committing. Make sure that you comment your commitseach commit. #: '''Note that in your branch you can commit your work even if it is not completeincomplete. In fact, commit your work anytime you are leaving your computer and comment it like: "going for lunch". But again you should only do this is only valid when you are working in '''''YOUR OWN BRANCH''''' # When your task is complete ## Update the repository to get apply all of the changes applied to your local copy## Merge the your changes back to trunk
#: Note that, the merging happens on the local copy and not the repository
# Edit possible conflicts, save and mark them as resolved when done.
# Compile the trunk, test and make sure that the changes are what you want
# In trunk, apply more changes and do debugging if needed.
#: note that this is the only time you do should be doing any work in trunk# When everything is perfect get ready prepare to commit the trunk:## Make sure that you are logged in to IRC.## Go to team page and set the trunk's status of trunk to committing with following info: User ID, email, IRC Nick, time and date## If the trunk's status of trunk is already committing by another user, communicate with them and find out when they are going to be done so you can do your commit.
##: ''Never commit to trunk with out checking and setting the status of trunk in your team page''
## Update the repository
# Commit the trunk
# Edit, save and resolve possible conflicts and go to previous step
# When done, go to the team page and set the trunk's status of trunk back to committed with the same info as before.
==Continue working on a task on a new computer (public computer)==
# Checkout only your branch/task
# start working Work on your task and keep committing the changes as you go.# when When done, do final commit, stating noting that the work period is done# Delete the checked-out directory from the public computer.
# '''''Reboot the computer'''''
#: this will remove your userid and pass password if you have chosen chose to save them.#: Note that you are responsible to keep you work safe, if . If someone gain gains access to your code and repository, YOU are responsible for it and its consequences.
==Continue working on a task (everyday work)==
# Update the repository to get the final most recent changes.
# (optional and only if needed:) If trunk is updated by someone else since the time you branched it, you can merge the '''updated''' trunk into your branch to get the latest additions and modifications of trunk in your branch.
# Continue working on your task and keep committing often.
# when done for the timebeing, commit your work and comment, stating at what noting the stage you areof your work.
==Release a completed task (Submitting an Assignment or a Release)==
# This is Do this when a major task is accomplished finished and it is time to present it to your professor.
#: This is not necessarily to hand in a new release. It could be at any time you feel you are one step closer to the end of the project.
# Update and make sure the trunk has the latest modifications.
# Do all possible changes and fixes to make this release final.
# tag Tag (branch) the trunk into a sub-directory in '''tags'''.
#: Name the tagged directory relative to its state (i.e. name it '''R0.4''' and comment it with task name '''Text Editor''')
#: If this is a fix to a previously released trunk, add the release revision after the release number: (i.e R0.41 and comment it as '''Fixed backspace bug in Text Editor''')