From 82e1aedd157f58321760f24f9871f417be61aaf6 Mon Sep 17 00:00:00 2001 From: Kevin Frantz Date: Thu, 13 Sep 2018 13:00:23 +0200 Subject: [PATCH] Updated documentary --- documentation/process/standards.md | 33 ++++++++++++++++++++ documentation/product/system/achitectur.md | 0 documentation/product/system/achitecture.md | 11 +++++++ documentation/product/system/design.md | 0 documentation/product/system/requirements.md | 1 + 5 files changed, 45 insertions(+) create mode 100644 documentation/process/standards.md delete mode 100644 documentation/product/system/achitectur.md create mode 100644 documentation/product/system/achitecture.md delete mode 100644 documentation/product/system/design.md diff --git a/documentation/process/standards.md b/documentation/process/standards.md new file mode 100644 index 0000000..229bc53 --- /dev/null +++ b/documentation/process/standards.md @@ -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*. diff --git a/documentation/product/system/achitectur.md b/documentation/product/system/achitectur.md deleted file mode 100644 index e69de29..0000000 diff --git a/documentation/product/system/achitecture.md b/documentation/product/system/achitecture.md new file mode 100644 index 0000000..1ff502d --- /dev/null +++ b/documentation/product/system/achitecture.md @@ -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. diff --git a/documentation/product/system/design.md b/documentation/product/system/design.md deleted file mode 100644 index e69de29..0000000 diff --git a/documentation/product/system/requirements.md b/documentation/product/system/requirements.md index d87f230..17cc2b6 100644 --- a/documentation/product/system/requirements.md +++ b/documentation/product/system/requirements.md @@ -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.