Developer guide

Continuous integration

There is a public Team City server configured for our project at: http://build.nzbdrone.com/teamcity/viewType.html?tab=buildTypeStatusDiv&buildTypeId=bt16
Use Login as Guest on Login page
These builds shouldn't be used as public available development builds (beta or RC)

To publish release version, the application version should be updated in Setup project and in Program startup object
Releases are marked with label. If you want to rollback to previous version load selected version release label
Tasks have iteration path "Terminals" until there is at least one related checkin. Then change the iteration path to the current development version
When fixing an issue, mark it as Fixed (not as Closed). Task is closed as a part of release, if there are no comments otherwise it is shifted to next version.

Don't keep your checkouts long time, use Shelve sets instead
Pickup from task stack only task, which you are able to solve in no more than two months
Always associate check-in change set with task, if your check in is related to it
In case of formating make two separate checkins: one which holds only code formating changes, second with fix/feature changes

Current development tool is Visual Studio 2010 with .NET C#.
The main solution project is configured to target .NET framework 3.5. But there are other external projects, which are still targeting .NET 2.0. Don't change the target framework for them.
For Logging the Log4Net is configured. Log files are stored under application Logs subdirectory.
To build the release setup use the "Distribution release" solution configuration. For general development use standard debug and release.
Output directory is default directory under the Terminals project.
Put all localize able resources under the Localization directory in resource file stored there.

Use Visual Studio 2010 default settings or similar settings in another editor.
For developer who are using Resharper, there is a Team shared configuration file for coding rules. Don't change this file, if you want to apply some rules. Discuss it first within the team.
Indents are 4 spaces. You can use Productivity Power Tools for VS to convert tab characters into spaces.
Fields should be declared private and above all methods.
Put curly brackets on a new line and close it in the same indentation.
Keep classes small up to maximum 500 lines
Keep methods small up to maximum 35 lines
Use usings as much as possible and remove not used usings
When using an if condition with one statement, put the statement on the next line.

   if (true)
       DoSomething();

When using an if condition with one statement after if condition and else condition, curly brackets are optional.

  if(true)
       DoSomething();
   else
       DoSomethingElse();

When using an if condition with curly brackets, use curly brackets for all attached conditions

   if (true)
   {
       x++;
       DoSomething();
   }
   else
   {
       DoSomethingElse();
   }

After an if, while, for each or other conditions that can use curly brackets, leave an empty line.

   if (true)
      DoSomething();

   x++;
   foreach(String s in stringArray)
   {
      Debug.Print(s);
   }
   
   DoTheNextThing();

Use String.Format when possible.
Use String.Empty instead of "", use String.IsNullOrEmpty() instead of (x == null | x = "").