This document will serve as the compendium for our company's standards.
Just like in code, documentations need some rules and practices to help readability:
- Multiple files divised by subjects instead of a single giant one
- Maintain some categorisation system and hierarchy to help browsing
- make use of folders
- Tests
- Mocks and stubs
- Time optimalization (TODO)
- Factories (TODO)
- Code readability and Patterns
- Service Objects
- Form Objects
- envs
- Local environment requirements
- 🚢 Deploy with Dokku
- Tools