Skip to main content

Project Structure and Organization

Readme file​

Each project must contain de Readme file that contains the following sections:

  1. Install
  2. Build
  3. Run
  4. Debug
  5. Release
  6. Architecture
  7. Contributing
  8. Testing

Package Manager​

Yarn must be the only used package manager

Dependencies​

Dependencies pinning must be applied.

Linter and Formatter​

ESLint and Prettier must both be used.

Prettier​

Following the official recommendations, Prettier must not be run in ESLint integration. As such, Prettier must be run directly by using two new commands: yarn prettier:check and yarn prettier:fix.

ESLint​

Eslint must only use the default recommended rules. Airbnb set of rules or plugin must not be used as it contains a lot of unrecommended rules and creates conflicts with Prettier.

Imports​

In each files, imports must be sorted using a consistent order. This order is the following:

  1. External packages
  2. Internal packages separated per subfolders (components/config/constants, etc.)
  3. Relative packages (these imports will be renamed soon to use the path mapping aliases)
  4. Local packages
  5. Styles