Good practice checklists
Use this checklist to demonstrate you follow our coding standards.
We cross-reference each checklist item to a relevant section in our standards and guides; Exceptions are noted where they may apply.
Folder structure good practice
| Item | Guide or standard | Exceptions | ||
|---|---|---|---|---|
| 1 | You use physical folders to separate logical areas of your software solution | ☐ | Use physical folders | |
| 2 | You include a README markdown file, instructing others on how to build and deploy your software solution | ☐ | Provide a README file | |
| 3 | You include a .editorconfig to allow your code style rules to be shared | ☐ | Provide a .editorconfig file | |
| 4 | You include a source folder | ☐ | Include a source folder | |
| 5 | You create subfolders to separate dependency layers | ☐ | Use additional subfolders for dependency layers | |
| 6 | You include a documents folder | ☐ | Include a documents folder | |
| 7 | You include folder for coded tests | ☐ | Include a test folder | |
| 8 | You include a builds folder | ☐ | Include a build folder | |
| 9 | You include a deploy folder | ☐ | Include a deploy folder | May only be required if deploying to cloud |
| 10 | You provide examples with your solution | ☐ | Include an examples folder |