Skip to main content

front-design-guides

Welcome to Posos' Design Guides for front-end projects !

This documentation provides a set of guidelines for establishing a robust and maintainable front-end codebases at Posos. These guidelines aim to improve code quality, scalability, collaboration, and overall project success. By adhering to these recommendations, developers can ensure consistency, efficiency, and ease of maintenance throughout every project's lifecycle.

Level of requirements

Here's how each term should be understood:

  • MUST: it's mandatory (i.e., hard rule)
  • MUST NOT: it's forbidden (i.e., hard rule)
  • SHOULD: it's heavily recommended (i.e., soft rule)
  • SHOULD NOT: there may exist valid reasons not to respect this but the implications should be well understood
  • MAY/OPTIONAL: it's optional (i.e., advice)

Requirements categories

  1. Contributing
  2. Documentation
  3. Project Structure and Organization
  4. Coding styles
  5. Testing and Quality Assurance