LOCAWEB STYLE

Documentação Locaweb Style

Contribuindo com o Locaweb Style

Quer ajudar no desenvolvimento? Ótimo!
Escolha uma das áreas e leia o guia para desenvolvedores a seguir:

  1. Javascript: melhorias de performance, novos comportamentos e componentes;
  2. Componentes/HTML: novos componentes e combinações;
  3. Documentação & Exemplos: melhorias na documentação e inclusão de novos exemplos de componentes e páginas combinando elementos.

Problemas & Sugestões

Utilizamos a parte de issues do Github para registrar, discutir e acompanhar bugs e melhorias.

Fique á vontade para registrar novos bugs/sugestões/pedidos e discutir os que já existem.


Estilo de código

Para o desenvolvimento, utilizamos as mesmas regras que sugerimos na seção Práticas e Padrões

Algumas informações adicionais estão apenas na parte "Contribua", por serem especificas de tecnologias utilizadas apenas no desenvolvimento do Locaweb Style, como SASS e Middleman.


Documentação

Contibua melhorando a documentação e adicionando novos exemplos.

As regras de como escrever documentação, como fazer exemplos ou inserir exemplos de código com syntax highlight estão na seção Documentação.


Testes

Utilizamos Jasmine para testes automáticos de javascript.

Confira os que já existem, e utilize o mesmo padrão:

  1. Códigos e describes em Inglês
  2. Testes assertivos positivos de preferência

Exemplos de componentes na Cartilha de Elementos NÃO são considerados testes!


História

Sempre que alterar algum elemento, adicionar algo ou fizer alguma alteração grande na documentação, anote no changelog, para que todos possam acompanhar de uma forma simples a evolução do Locaweb Style.

Para o controle de versões e documentação nos guiamos pelo Semantic Versioning 2.0.0