Skip to content

Commit

Permalink
Update contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
steinelg authored Feb 5, 2024
1 parent 14876cb commit 65a3c95
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ appreciated.
- All code should follow conventional C# naming conventions, please refer to https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/naming-guidelines,
- this includes using camelCase or PascalCase as appropriate for varibale names, and
- names of variables and classes should prioritize readability over brevity, and not include abbreviations or underscores
- name new classes and variables in ways that are consistent with the names already used.
- name new classes and variables in ways that are consistent with the names already used.
- all unit tests should follow the naming convention ``MethodName_StateUnderTest_ExpectedBehavior`` or for simple classes ``StateUnderTest_ExpectedBehavior``
- Organize code so that others can easily undertand, maintain and extend it:
- Favor smaller classes and methods that have a single specific purpose, clearly expressed in the name.
- Use unit test framework during development, and keep tests in project as part of documentation and as a "fail-safe" mechanism for other developers
Expand Down

0 comments on commit 65a3c95

Please sign in to comment.