Skip navigation

Coding convention

Coding convention for backend development in Alloy Template project.

Default coding convention

The backend development team of the Alloy Template project follows a default coding convention, which is defined in the /.editorconfig file. This file contains Microsoft's recommended coding convention, but with stricter rules. For instance, if a new const field is created without using Pascal case, the compiler will raise an error during code build.

This approach is intentional, as the Alloy Template project serves as the foundation for future projects, and any inconsistency in coding style may be inherited. Thus, ensuring consistency is crucial.

If you plan to use this template for your project, it's advisable to replace the /.editorconfig file with a less strict one or lower the severity level. While the rules in this template are excellent for maintaining consistency, they can be challenging to follow in day-to-day development.