Coding standards

Contribution guidelines and standards

The following are instructions for setting up an environment for CSLA .NET development.

Getting started

• Review the contributor guidelines
• You must have a GitHub account to fork the repository and create pull requests

Dev environment setup

You will need to set up your development workstation with the following

• Visual Studio 2012
  • Important: You need to set your global tab size to 2, and choose the option to replace tabs with spaces (no tabs allowed!)
  • Make sure Visual Studio is running the latest updates from Microsoft, CSLA .NET is almost always at or ahead of any current release of Visual Studio tooling
  • Silverlight 5 SDK and tools
  • WP8 SDK and tools
• Git client tooling of your choice
  • Git for Windows
  • TortoiseGit
  • Git tool from GitHub

Getting the project

Once you have that all installed, and you have your GitHub credentials, you’ll need to do the following:

• Fork the Marimer LLC csla project
• Clone your fork to your dev workstation
• Create a branch in which to do your work

Coding standards

As far as coding standards – follow the code style you see in CSLA .NET. Here are some basic guidelines/rules:

• Please make sure to set your Tab stops to 2 and to USE SPACES in VS
• Casing and stuff
  • Use _fieldName for all instance fields
  • Use ClassName
  • Use PropertyName and MethodName
  • Use parameterName for parameters
• Only check in code if it builds for.NET, Silverlight, and Windows Phone – csla.silverlight.test.sln and csla.wp.test.sln are good tests to ensure a successful build
• When you do a Commit make sure to follow the proper format for the commit description

#99999 Detailed description of your change here