rhuanmmaciel / DBest

Um Sistema Gerenciador de Banco de Dados que visa a exposição de um plano de execução de consulta completo. Ele funciona com árvores de operadores sobre tabelas(Fyi, csv).
8 stars 2 forks source link

Padronização do estilo de código #4

Closed wisentini closed 1 year ago

wisentini commented 1 year ago

Hoje à tarde eu fui atualizar minha branch a partir da principal e acabou resultando em vários conflitos, grande parte por causa do estilo de código (e.g., indentação, linhas em branco, espaçamento entre operadores, etc). Eu acho que isso pode ser um problema lá na frente, então seria uma boa a gente adotar um padrão de codificação. Isso pode ser feito tanto pela configuração da IDE, já que usamos a mesma (IntelliJ IDEA), ou pelo EditorConfig (um arquivo de configuração de estilo de código que fica no diretório raíz do projeto), que é uma solução bem consolidada pra esse tipo de problema.

Estilo de código é algo meio subjetivo, mas não dá pra negar que existem boas práticas seguidas por grande parte da comunidade Java, então eu acho que é válido tirar um tempo pra pensar nisso, não só pela qualidade do código, mas também pra economizar tempo futuramente nos merges.

Aqui tá o .editorconfig que eu montei a partir de outros que encontrei na web. A gente pode discutir a estrutura dele nesse issue, se faz sentido ou não o estilo que ele gera. Pra usar, é só copiar ele pro diretório raíz do projeto (DBest/sgbd/) e ativar o plugin EditorConfig do IntelliJ IDEA.

Quando a gente entrar em um consenso, começamos a usar ele! :D