stvalett/guidelines

The TAGWALK developers guidelines

Guidelines

The TAGWALK developers guidelines.

WEB-APP

Resources:

• https://www.12factor.net/

SCSS

Resources:

• https://sass-guidelin.es/

CSS

General rules:

• class/attributes naming: snake-case
• never use !important
• do not use px unit for bloc size
• try to avoid use of id attribute when possible, use class instead
• use rem unit for font-size, margin and padding properties
• use % unit for height and width properties

Resources:

• https://cssguidelin.es/
• https://www.sitepoint.com/sass-semantically-extend-bootstrap/
• http://smacss.com/

JS

General rules:

• data-* attributes are designed to store data
• prefer import as require see more

Resources:

• http://jstherightway.org/
• https://www.w3schools.com/js/js_conventions.asp
• https://google.github.io/styleguide/jsguide.html
• https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide
• https://github.com/airbnb/javascript
• https://github.com/rwaldron/idiomatic.js

PHP

General rules:

• Use PHP 7
• Write unit and/or functionnal tests when possible and relevant
• Use type hint in PHP function parameters and return values

Coding Standards:

• https://symfony.com/doc/current/contributing/code/standards.html

Resources:

• https://www.php-fig.org/psr/psr-2/

Symfony

Resources:

• Slack support: https://app.slack.com/client/T39U3FUKV/C3EQ7S3MJ
• Documentation: https://symfony.com/doc/current/