Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • P Projeto Rivi Wiki
  • Project information
    • Project information
    • Activity
    • Labels
    • Planning hierarchy
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Infrastructure Registry
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Projeto RIVI
  • Projeto Rivi Wiki
  • Wiki
  • codigo

codigo · Changes

Page history
Update codigo authored Nov 10, 2022 by Fernando Luiz Elger's avatar Fernando Luiz Elger
Show whitespace changes
Inline Side-by-side
codigo.md
View page @ 12f8d6f1
......@@ -15,7 +15,48 @@ Aqui serão apresentadas as convenções do código desenvolvido. padrões, docu
## Ferramentas de Padronização
TBD
Iniciando o projeto, é importante notar que foram aplicadas regras de
- Prettier
- Conventional Commits
e não será possível realizar um commit bem sucedido caso o código adicionado fuja dos padrões especificados nas regras.
### **1. Prettier**
O Prettier é uma ferramenta de formatação de código que padroniza coisas como identação, espaçamento, etc.
As configurações do Prettier já estão definidas no projeto, porém é preciso adicioná-lo em seu editor de prefêrencia.
Caso esteja usando o VSCode, basta abrir o painel de _Extenções_ com <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>x</kbd> , pesquisar por "Prettier" e instalar.
As configurações do Prettier no VSCode também estão no repositório em [settings.json](.vscode/settings.json), portanto basta usar <kbd>Ctrl</kbd> + <kbd>s</kbd> que o editor salva e realiza as formatações.
Códigos que fojem dos padrões de formatação do Prettier serão rejeitados automaticamente.
Configurações definidas:
```
"semi": true --> Adiciona ponto e vírgula no final
"singleQuote": true --> Garante o uso de aspas simples sempre
"tabWidth": 2 --> Identa usando 2 espaços
"printWidth": 100 --> Define tamanho máximo de uma linha do código
```
### **2. Conventional Commits**
O Conventional Commits é um padrão de commit vastamente utilizado na indústria, inicialmente concebido pelo Google Angular, [veja mais sobre aqui!](https://www.conventionalcommits.org/en/v1.0.0/)
Nesse projeto, existem ferramentas para facilitar os commits de acordo com as regras estipuladas, basta escrever:
```sh
yarn commit
```
e um menu irá guiar o usuário para realizar o commit da maneira adequada.
É importante notar que o processo de commit também pode ser feito normalmente da maneira tradicional.
Commits que fojem dos padrões de commit do Conventional Commits serão rejeitados automaticamente.
### Nomenclatura de Arquivos
......@@ -23,8 +64,6 @@ TBD
### Documentação
TBD
### Código
TBD
Clone repository
  • Gerência
  • Instalação
  • Retro
  • Utilizando a wiki
    • adicionando imagens
    • escrevendo em markdown
    • wiki no editor de texto
  • arquitetura
  • banco_dados
  • codigo
  • configuracao
  • design_mockups
  • escopo
  • estudos
  • gerencia
  • Home
View All Pages