Objectives and Responsibilities
Objectives
This document attempts to provide guidelines, for .NET and C#developments, that are both valuable and pragmatic.
Coding conventions serve the following purposes:
- They create a consistent look to the code, so that readers can focus on content, not layout.
- They enable readers to understand the code more quickly by making assumptions based on previous experience.
- They facilitate copying, changing, and maintaining the code.
- They demonstrate C# best practices.
If you do not follow these recommendations, You have a good reason !
This document is mainly based…
- On our experience to write the simplest and best performing code possible.
- On CSharp Coding Guidelines web site.
- On Microsoft Coding Conventions.
Responsibilities
The developer is the only one responsible for the code, unit tests and documentation he has written.
| User | Developer | Reviewer | Manager |
|---|---|---|---|
| Source Code | X | (x) | |
| Documentation | X | (x) | |
| Unit Tests | X | (x) | |
| Conventions | X |
Definition of DONE
In Scrum, the Definition of Done is the exit-criteria to determine whether work on sprint backlog item is complete. for example: the DoD requires that all regression tests be successful. The definition of done may vary from one team to another but must be consistent within one team.
By convention, in our projects, a Task or a User Story must respect all of these criteria of Definition or Done:
- All code is developed using current naming conventions.
- Unit-tests must cover all code, including success and failure paths.
- All code is submitted to the Continuous Integration builds and compiles (without errors) with all tests passing.
- Verify behavior against the acceptance criteria with the product owner.
- Document just enough to communicate intent.