Guias

guias para trabalhar da melhor forma

Estes guias foram criados para padronizar todo o workflow de desenvolvimento na Mkt Virtual. Do código ao deploy, eles cobrem cada parte do nosso trabalho diário.

Esta é uma versão em desenvolvimento.

Princípios

O desenvolvimento na Mkt Virtual é guiado por alguns princípios. Todas os guias servem para que sigamos estes princípios fundamentais:

• Legibilidade - esse é um dos mais importantes. 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 lisos 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 Mkt Virtual, podemos usar qualquer editor. Vim, SublimeText, Brackets, TextMate ou outros. Nós usamos o EditorConfig para manter o código consistente e seguindo as diretrizes deste guia. As regras estão no arquivo .editorconfig.

Instale plugins para Vim, SublimeText, Brackets, TextMate ou outro editor.

Sumário

• Estilo

  • Geral
  • CSS
  • Javascript
  • PHP

• Boas práticas

  • CSS
  • Git
  • Javascript
  • PHP
  • Automação

• Ferramentas

  • Geral
  • Front-end
  • Back-end

Créditos

Guias é mantido pela Mkt Virtual. Ele segue conselhos de especialistas, dicas de grandes profissionais e opiniões de desenvolvedores apaixonados pelo que fazem.

Esta é uma adaptação de diversos guias para a nossa realidade. Algumas referências:

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

Licença

Guias foi criado pela equipe da Mkt Virtual. Ele é uma adaptação de Guides, por thoughtbot, inc e outros guias distribuídos livremente (referênciados devidamente em cada página). Ele é distribuído sob a licença MIT.