Standards (WiP: Expect dead links for now)

Standards used @ Galvão Desenvolvimento Ltda.

ToC

1. The 10 Core Principles
2. Logging
   • Implementation
3. Versioning
   • Implementation

The 10 Core Principles

1. Security first, then quality and only then everything else. Everything done as simple as possible: K.I.S.S.;
2. Think first, then code.
3. Documentation must be created before, improved during and indexed after development;
4. Any tools that might help are acceptable, blindly pasting code isn't;
5. The right tool is the one that achieves the goal and is known or reasonably "learnable" within the project scope;
6. Honesty always, but honesty doesn't equal rudeness;
7. Reasonable investments and deadlines only change if the scope changes as well: that's why they're called reasonable;
8. Never pretend to know what you don't; Always learn what you can;
9. Popularity is an important metric, but never the most important;
10. Made a mistake? Do a Post-mortem. Mistakes are always welcome: if you don't make them you don't learn.

Logging

1. Logs are always stored on disk, at the data/log folder;
2. For complex projects, logs may be segmented in subfolders (see the streams static attribute of MonologWrapper).
3. Log filenames are always in the Y-m-d.log format;
4. Log messages are in the following format:

   $lineFormat = "%datetime% - [ %level_name% ]: %message%\nDATA:\n%extra%\n\n";

5. Timestamps (the %datetime% placeholder in Monolog) are always stored in the following format: H:i:s;
6. Timestamps may use GMT offset indication, if needed. In this case, the offset should be represented as Hm (no semi-colon, the O format);
7. Log files should be periodically rotated and backed up (see the LogRotate project).

Logging Implementation:

PHP - MonologWrapper

Versioning

1. Versioning is always done using Semantic Versioning;
2. There's always a branching strategy in place (See the g-flow project)