Padrões de codificação de clean code
Do git
Para o github foi definido um gitflow de 3 branchs (main, dev e features branchs)
Do front
Para o front mantidas as convensões mais usadas do React:
- Nomes de componentes, variaveis e similares em ingles
- Comentarios em portugues
- PascalCase para nomes de componentes
- camelCase para nomes de variaveis e estados
Alem disso foi definido o uso do Prettier com a seguinte configuração para formatar o .jsx
{
"arrowParens": "always",
"bracketSpacing": true,
"jsxSingleQuote": false,
"printWidth": 100,
"proseWrap": "always",
"semi": false,
"singleQuote": false,
"tabWidth": 4,
"trailingComma": "es5",
"useTabs": false,
"endOfLine": "auto"
}
Do back
Para o front serão mantidos convensões mais usadas do Java:
- Nomes de variaveis em ingles
- Comentarios em portugues
- PascalCase para nomes de Classes
- camelCase para nomes de variaveis
Histórico de revisão
Data | Versão | Descrição | Autor |
---|---|---|---|
06/05/23 | 1.0 | Criação do documento | Ricardo |
10/06/23 | 1.1 | Padrões de codificação | Ricardo |
14/06/23 | 1.2 | Padrões de codificação | João |