Developer Best Practices

R.SANTHANA GOPALAN

Developer Best Practices

What is Workspace ?The directory where the developer edit the

source files, compile, test and debugWe can get the workspace by checkout

from the CVS.

Developer Best Practices

Don't share workspacesEach developer should work on their work

space.Sharing workspaces confuses people, just

as sharing a desk does

Developer Best Practices

Avoid duplication of workspacesAlways do a new feature/development

source codes within the same workspaces. The duplication of workspaces gives lot of

confusion and it affects the whole project cycle also

Developer Best Practices

Don't use jello views A "jello view" is a workspace where file

changes are caused by external events beyond your control.

Eg: Workspace contains a file is linked to another file in some other directory. When the underlying files are updated, your workspace files change.

Developer Best Practices

Stay in sync with the codelineThe quality of your work depends on how

well it meshes with other peoples' work. Most of the integration problem will be

solved by updating the workspaces properly.

Developer Best Practices

Check in oftenOnce you've finished a development task,

check in your changed files so that your work is available to others.

Delaying the check-in sources will affect the productivity and gives the integration problems.

Developer Best Practices

Reviewing the changesBefore check-in the sources review the

changes using “cvs diff”.Reviewing the sources will make sure only

the required changes are integrated into the repository

Avoid the debug statements check-in to the repository.

Developer Best Practices

Use proper Change LogLog message gives the brief description of

what is changed between the previous version of the source files.

Any developer can able to see the log messages using “cvs log” and understand the reason for the changes.

Developer Best Practices

Avoid Module ViolationDon’t check-in the source that are not

belonging to your moduleModule team should have more knowledge

about the team and they should know about the requirements and the bugs.

Developer Best Practices

Use different workspaces for the BranchThe branch development line contains only

few files and the required files will be branched on request.

This will avoid lot of confusion with the main development line and gives the clear view of what to be done

Developer Best Practices

Propagate the branch changes early and oftenPostponed and batch change propagation's

can result in stunningly complex file merges.