Updated documentary

This commit is contained in:
Kevin Frantz 2018-09-13 13:00:23 +02:00
parent d1b7e0f070
commit 82e1aedd15
5 changed files with 45 additions and 0 deletions

View File

@ -0,0 +1,33 @@
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”,
“SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be
interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
# standards
## coding standards
### php
PHP code MUST follow the [PSR-4](https://www.php-fig.org/psr/psr-4/) standard.
### twig
Twig templates MUST follow the [Symfony Template best practices](https://symfony.com/doc/current/best_practices/templates.html).
### naming
#### interfaces
A Interfaces MUST be named *ClassnameInterface*.
It SHOULD be based in the directory of the class.
#### abstract classes
A abstract class MUST be named *AbstractClassname*.
It SHOULD be based in the directory of the classes which inherit from it.
#### entities
##### source
A source MUST be named *SourcenameSource*.

View File

@ -0,0 +1,11 @@
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”,
“SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be
interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
# architecture
## application
The application MUST be based in the application folder.
The application MUST use Symfony 4.

View File

@ -119,6 +119,7 @@ A **file** MUST be on of the following types:
* TEXT
* CSV
* JPG
* MD
It SHOULD be possible to export a **file** to one or more other **file** s.