Skip to content

Instantly share code, notes, and snippets.

@lee-dohm
Last active August 29, 2015 14:23
Show Gist options
  • Save lee-dohm/5d7d23cdd024fd5f1f46 to your computer and use it in GitHub Desktop.
Save lee-dohm/5d7d23cdd024fd5f1f46 to your computer and use it in GitHub Desktop.
Code Convention Guidelines System

The guidelines will follow the convention described in Microsoft's .NET Framework Design Guidelines:

The guidelines are organized as simple recommendations using DO, CONSIDER, AVOID, and DO NOT. For example, a Do guideline is one that should virtually always be followed. On the other hand, Consider guidelines should generally be followed, but if you fully understand the reasoning behind a guideline and have a good reason to not follow it anyway, you should not feel bad about breaking the rules. Similarly, Do not guidelines indicate something you should almost never do. Less strong, Avoid guidelines indicate that something is generally not a good idea, but there are known cases where breaking the rule makes sense.

Some more complex guidelines are followed by additional background information, illustrative code samples, and rationale.

The guidelines will follow the convention described in Microsoft's .NET Framework Design Guidelines:

The guidelines are organized as simple recommendations using DO, CONSIDER, AVOID, and DO NOT. For example, a Do guideline is one that should virtually always be followed. On the other hand, Consider guidelines should generally be followed, but if you fully understand the reasoning behind a guideline and have a good reason to not follow it anyway, you should not feel bad about breaking the rules. Similarly, Do not guidelines indicate something you should almost never do. Less strong, Avoid guidelines indicate that something is generally not a good idea, but there are known cases where breaking the rule makes sense.

Some more complex guidelines are followed by additional background information, illustrative code samples, and rationale.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment