Essential good practice checklist
Practical tips
Discuss with colleagues and hold code reviews to ensure a shared understanding of our standards.
Further reading and information
Giving code a good name - Kevlin Henney - YouTu be
Seven ineffective coding habits of many programmers - Kevlin Henney - YouTu be
| Item | Guide or standard | Exceptions | ||
|---|---|---|---|---|
| 1 | Your code is terse, expressive and underpinned with coded tests. | ☐ | Write clean code | - |
| 2 | Classes follow SOLID principles. | ☐ | Follow SOLID principles | - |
| 3 | You follow Microsoft's C# coding conventions and Framework Design Guidelines. | ☐ | Follow Microsoft's coding conventions | Unless you have agreed to follow a local coding standard. |
| 4 | You handle exceptions and use defensive coding techniques. | ☐ | Exception handling and defensive coding | - |
| 5 | You calculate code metrics. | ☐ | Calculate code metrics | |
| 6 | You calculate code coverage. | ☐ | Calculate code coverage | |
| 7 | You analyse code for style and quality. | ☐ | Check code for style and quality | |
| 8 | You analyse code for security vulnerabilities. | ☐ | Analyse your code | |
| 9 | You share your analysis rules in source control. | ☐ | Analyse your code | |
| 10 | You perform code analysis in build pipelines. | ☐ | Run code analysis in your pipelines | |
| 11 | You check third party dependencies for security vulnerabilities. | ☐ | Check third-party packages | |
| 12 | You publish metrics to your dashboards. | ☐ | Publish and review ,metrics |