We follow the airbnb style for naming.
We mainly follow the standard style for JavaScript, although there may be smaller deviations.
Run the linter (yarn lint
) to show problems. Our eslint config can be found here.
See this guide for a general reference on how to write
good commit messages.
Commit messages should have the following schema:
<Issue key>: Your commit message
, e.g. WEBAPP-612: Add commit message documentation
The same applies for PR names.
The following schema is used for versioning.
PATCH
is a counter for the number of releases in the corresponding month starting with 0.
Examples:
- First versions of 2020:
2020.1.0
,2020.1.1
,2020.1.2
. - First version of February 2020:
2020.2.0
.
├── __mocks__
├── modules
│ └── app
│ ├── constants
│ ├── assets
│ ├── components
│ ├── containers
│ ├── actions
│ ├── hocs
│ └── reducers
└── routes
└── route-name
│ ├── assets
│ ├── components
│ ├── containers
│ │ └── RouteNamePage.js
│ ├── actions
│ ├── hocs
│ └── reducers
A component always follows the following structure (Uppercase files always contain a single class):
├── __tests__
│ └── Caption.js
├── Caption.css
└── Caption.js