Read Me

Source Code Maintenance


1. Version control system : svn

	For source code version control we are using svn. 
	In order to checkout and commit changes an svn client is required.
	Once you have svn client installed on your laptop/pc it is very simple to checkout and commit changes.
	
	1.1 Checkout 
		$ svn co https://cent-de.svn.sourceforge.net/svnroot/cent-de cent-de
	1.2 Update
		$ svn update
	1.3 Diff
		$ svn diff (used for obtaining unified diff)
		$ svn diff --diff-cmd tkdiff (used for comparing changes. tkdiff should be installed)
	1.4 Commit
		$ svn commit --editor-cmd vim
	Note: For more svn related info please refer svn manual.
	 
2. Code Review Tool: Code striker
	
	It is highly recommended that a review topic should be submitted before committing a code.
	To submit a review topic follow the given steps:
	
	2.1 Generate an unified diff
		$ svn diff > diff.txt
	2.2 Login to sourceforge.net and go to Cent-DE project

	2.3 Open ["Hosted Apps" -> "Code Striker" -> "Create New Topic" ]

	2.4 Write a brief summary and description related to the changes.
	
	2.5 Set Repository to "cent-de SVN" and add reviewers

	2.6 Create Topic

3. Code Comment Style: javadoc comments

	It's always a good practice to stick to a uniform commenting style.
	We will be using javadoc comments as Doxygen is used to document the code.
	Code Reference Doc is updated twice a week and can be obtained from 
	Cent-DE project page [ "Files" -> "Source Code Ref" -> "cent_de.pdf" ]