Difference between revisions of "Using the SVN Tool for A2"

From CDOT Wiki
Jump to: navigation, search
(Practical Guidelines)
Line 1: Line 1:
 
== Practical Instructions ==
 
== Practical Instructions ==
 +
 
*READ the SVB book at red-bean.com. (FYI - Resources on the course wiki page.)
 
*READ the SVB book at red-bean.com. (FYI - Resources on the course wiki page.)
 
**Understand the concept of source code version control.
 
**Understand the concept of source code version control.
Line 27: Line 28:
  
 
== Collaboration Requirements ==
 
== Collaboration Requirements ==
 +
 
*Effective team work should produce '''high-quality code''' base. Team work is not an excuse for being lazy.
 
*Effective team work should produce '''high-quality code''' base. Team work is not an excuse for being lazy.
 
*Select a team leader who is responsile for merging branches with trunk.
 
*Select a team leader who is responsile for merging branches with trunk.

Revision as of 09:45, 19 October 2012

Practical Instructions

  • READ the SVB book at red-bean.com. (FYI - Resources on the course wiki page.)
    • Understand the concept of source code version control.
    • Identify the basic operations you need to work with an SVN code repository.
  • View these (or other) video clips:
    • Best Practices for Subversion (SVN) [1]
    • Subversion Basics with TortoiseSVN Tutorial [2]
    • Subversion Branch Merge Tutorial [3]
  • Download and install TortioseSVN. Read the documentation whenever needed.(FYI - Resources on the course wiki page.)
  • Each team should receive SVN accounts on zenit.senecac.on.ca.
  • Set up the following directory structure for your SVN code repository
/trunk
/branches
/tags

Create a README file in the trunk. It should contain information about the project such as the names of the team members, the starting date of the project, a brief description of the project, command lines (or tools) to compile the source code, a script file to build the source code, and so son. Create a README file in a branch. It should contain the name of the person who's responsible for developing the class(or classes) in this branch. It should also contain a list of bugs fixed (including the names of the team members).

Create concise but informative change log files whenever you do commits. (To find out more about changelogs, do a Google search on Change Log Example.) Here are some links to get your started.

Tags are meant to be snapshots of the trunk. Do not make any changes to a tag. You should tag when you are ready to make a release. For Release 0.2, store the three executables in a sub-directory of the trunk of your repository. Branch the sub-directory to A2.R0.2 under the tags directory of your repository. Do the same thing for Release 0.3.

Collaboration Requirements

  • Effective team work should produce high-quality code base. Team work is not an excuse for being lazy.
  • Select a team leader who is responsile for merging branches with trunk.
  • Divide the work of A1 Release 0.2 among the team members. Each team member should be responsible for developing one specific C++ class (e.g. CButton).
  • Each team member should create a branch to work on that class.
  • A branch should be labelled by the name of a team member (e.g. john).
  • Everyone on the team can debug the source code in any of the branches. (Warning: The number of bugs fixed for a particular class reflect the quality of code initially developed (contributed) by the team member. This could affect the final marks that a team member could receive. In brief, each team member should work as hard as other team members. Do not contribute poor quality code to the code repository (i.e the shared code base). At the end of the project, a group evaluation scheme will be used to asses the performance of each team member.)