Locaweb Style

Documentação

Saiba todas as features que te ajudarão a produzir sistemas mais rapidamente.

Contribua

O que você precisa saber para iniciar sua contribuição

Para contribuir, fique atento às informações abaixo e siga totalmente as informações que estão escritas em Práticas e Padrões. Você pode não querer escrever código, por isso, há espaço para reportar os problemas que você encontrar. Abaixo segue mais instruções de como continuar:

Fork do projeto no GitHub

A primeira coisa que você precisa fazer é um fork do projeto no GitHub. Feito isso, leia atentamente as instruções abaixo e mande bala!

Estilo de código

Uma boa prática é que embora um código esteja sendo escrito por várias pessoas, ele deve parecer que foi feito apenas por uma. Por isso o estilo e padrões são tão importantes. Se você quiser contribuir com código, tenha certeza de que está escrito no estilo que descrevemos na área Práticas e Padrões.

Nessa área você encontra todos os nossos padrões e boas práticas que usamos no projeto.

Prefixo de Nomenclatura

Para evitar conflitos com o código alheio, usamos sempre o prefixo ls-. Dessa forma conseguimos ter uma série de vantagens ao migrar sistemas, corrigir bugs e conflitos com códigos de plugins ou do próprio projeto.

Testes

Nós usamos Jasmine para conduzir os testes em JavaScript. Se você contribuir com código JavaScript, tenha certeza de que fez os testes corretos para sua função. Não aceitamos Pull Requests sem testes. Ah, os códigos dos describes devem estar em inglês.

Problemas e Sugestões

As issues do GitHub são o lugar certo caso você encontrar qualquer erro ou tiver alguma ideia genial para melhorar o framework. Sempre nos comunicamos por lá com os reporters e também para marcar nossas tarefas públicas.

Abra suas issues aqui.

Como instalar o projeto localmente para desenvolvimento

Instalação no Ubuntu