Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-20 00:23:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add worklow docs

Browse Source
This commit is contained in:
Karl-Philipp Wulfert
2018-11-30 17:09:20 +01:00
parent c3182caba5
commit 7981463255
13 changed files with 289 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
project-docs/workflow/CODING.md Normal file
View File

@@ -0,0 +1,18 @@
# 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`](https://gitlab.com/openstapps/configuration/blob/master/README.md). 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.
## Further resources
* [Commit guidelines](COMMITS.md)
* [TypeScript coding guidelines](https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines)