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.