Diretrizes de Desenvolvimento

Algumas diretrizes para trabalhar de maneira organizada e consistente.

Estes guias são baseados em ideias sugeridas pela comunidade para melhorar o entendimento e a organização dos processos de desenvolvimento e do código criado. Eles abordam desde o código ao deploy e cobrem cada parte do workflow diário da CodeDev.

Princípios

O desenvolvimento na CodeDev é guiado por alguns princípios. Todas os guias a seguir baseiam-se nestes princípios fundamentais:

• Legibilidade: Antes de computadores lerem nossos códigos, desenvolvedores lerão. Ter um código legível é imprescindível para manter a equipe produtiva e os projetos o mais organizado possível.
• Organização: Em um ambiente organizado, trabalhamos melhor e com menos stress. Algumas regras e boas práticas nos ajudam a organizar nosso código e todo o projeto.
• Simplicidade: Nosso código e nossos projetos devem ser o mais simples possível, nunca menos ou mais que isso. Ambientes simples facilitam a entrada de novos integrantes e também a escalabilidade de cada projeto.

Diretrizes gerais

• Seja consistente.
• Não reescreva código existente para seguir estes guias.
• Não viole diretrizes sem uma boa razão.
• Uma razão é boa quando você pode convencer alguém da equipe.
• Leia todos os anexos indicados por "(?)".

EditorConfig

Na CodeDev, podemos usar qualquer editor ou IDE. Atom, SublimeText, PHPStorm, Visual Studio Code, Vim ou, até mesmo, o bom e velho Notepad++. Não importa. Fica a se critério qual editor usar.

Isso é possível porque nós usamos o EditorConfig para manter o código formatado e consistente, seguindo as diretrizes deste guia. As regras estão sempre no arquivo .editorconfig.

Para isso basta instalar o plugin feito para o editor que você usa: Atom, SublimeText, PHPStorm, Visual Studio Code, Vim, Notepad++ ou outro editor.

Sumário

• Estilo

  • Geral
  • CSS
  • Javascript
  • PHP

• Boas práticas

  • CSS
  • Git
  • Javascript
  • PHP

• Ferramentas

  • Geral
  • Front-end
  • Back-end

Créditos

Estes guias são mantidos pela CodeDev. Esta é uma adaptação de diversos outros guias para a nossa realidade. Algumas referências:

• Guides por thoughtbot
• CSS Guidelines por csswizardry
• Javascript por airbnb

Licença

Estes guias foram escritos pela equipe da CodeDev. Ele são uma adaptação de Guides, por thoughtbot, inc e outros guias distribuídos livremente (referênciados devidamente em cada página). Eles estão distribuídos sob a licença MIT. Fique a vontade para copiar e redistribuir da maneira que desejar. ツ