Esse reposit贸rio foi criado com o objetivo de documentar os nossos processos de desenvolvimento e como escrevemos c贸digo.
Assim como Hugo Giraudel diz em Sass Guidelines:
Um styleguide n茫o 茅 apenas um documento agrad谩vel de ler, ou a defini莽茫o de como o c贸digo deve ser escrito idealmente. Ele 茅 um documento chave na vida do projeto, descrevendo como e porque o c贸digo deve ser escrito. Ele pode parecer um exagero para projetos pequenos, mas ele ajuda muito a manter a codebase limpa, escal谩vel e f谩cil de manter.
Nem preciso dizer que, quanto mais programadores no projeto, mais guidelines n茫o necess谩rias. Na mesma linha, quanto maior 茅 o projeto, mais styleguides s茫o necess谩rias.
E Harry Roberts em CSS Guidelines:
Styleguides de c贸digo (note, n茫o um styleguide visual) 茅 uma valiosa ferramenta para times que:
- constroem e mant锚m produtos por uma quantidade consider谩vel de tempo;
- tem desenvolvedores com diferentes habilidades e especialidades;
- tem diferentes desenvolvedores trabalhando no projeto a qualquer momento;
- traz novas pessoas para o projeto regularmente;
- tem v谩rias codebases que os desenvolvedores entram e saem.
Nosso objetivo 茅 definir um padr茫o para escrever c贸digo limpo e sem芒ntico. N贸s nos preocupamos muito com a legibilidade de c贸digo e se outras pessoas desenvolvedoras conseguem entender facilmente o que estamos fazendo e como estamos pensando sobre o c贸digo.
O time inteiro pode contribuir com esse reposit贸rio, dando sugest玫es e fazendo mudan莽as. Seja bem-vindo(a)! : )
Primeira vez aqui? N贸s recomendamos come莽ar lendo Configurando o editor de c贸digo e depois Fluxo de trabalho.
Ao inv茅s de criar styleguides espec铆ficos para cada linguagem que utilizamos, n贸s decidimos apenas utilizar linters e deixar os arquivos de configura莽茫o nos nossos projetos, assim facilitando o uso dos nossos styleguides. Voc锚 pode ler Configurando o editor de c贸digo para entender como utilizar os linters no seu editor de c贸digo favorito.