mirror of
https://gitlab.com/openstapps/openstapps.git
synced 2026-01-17 23:22:54 +00:00
807 B
807 B
Coding style
These guidelines are meant for TypeScript based project but can be adapted for projects that are developed in other languages as well.
Configuration
Consistent code structure and style is ensured by using @openstapps/configuration. It contains configuration files for your editor, the TypeScript compiler and TSLint.
Comments
Plenty of inline comments should be used to make it easier to understand what the code is doing.
Inline comments should not explain what code from external projects is doing. Add missing documentation to those external projects.