Skip to content
Browse files

Updated CONTRIBUTING.md with style guidelines

  • Loading branch information...
1 parent 9bc3162 commit db6f47ca698a2fa56aefa5b025f6045c9f48ca3f @khellang khellang committed Jul 16, 2014
Showing with 14 additions and 1 deletion.
  1. +14 −1 CONTRIBUTING.md
View
15 CONTRIBUTING.md
@@ -38,4 +38,17 @@ When you're ready to go you should confirm that you are up to date and rebased w
1. `git push origin myBranch`
1. Send a descriptive [Pull Request](http://help.github.com/pull-requests/) on GitHub - making sure you have selected the correct branch in the GitHub UI!
-1. Wait for @TheCodeJunkie to merge your changes in and reformat all of your code because he has StyleCop OCD :wink:.
+1. Wait for @TheCodeJunkie to merge your changes in and reformat all of your code because he has StyleCop OCD :wink:.
+
+And remember; **A pull-request with tests is a pull-request that's likely to be pulled in.** :grin:
+
+## Style Guidelines
+
+- Indent with 4 spaces, **not** tabs.
+- No underscore (`_`) prefix for member names.
+- Use `this` when accessing instance members, e.g. `this.Name = "TheCodeJunkie";`.
+- Use the `var` keyword unless the inferred type is not obvious.
+- Use the C# type aliases for types that have them, e.g. `int` instead of `Int32`, `string` instead of `String` etc.
+- Use meaningful names (no hungarian notation).
+- Wrap `if`, `else` and `using` blocks (or blocks in general, really) in curly braces, even if it's a single line.
+- Put `using` statements inside namespace.

0 comments on commit db6f47c

Please sign in to comment.
Something went wrong with that request. Please try again.