Skip to content

Latest commit

 

History

History
33 lines (18 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

33 lines (18 loc) · 2.64 KB

Como contribuir

Ficamos muito felizes de ter você conosco neste projeto! Muito obrigado por tirar um tempo para ler esse documento antes de mais nada!

Muito provavelmente você já conhece o projeto e sabe do que se trata, mas se você caiu de paraquedas aqui, leia o README e dê uma olhada na última versão em produção do site.

Novo neste mundo do Github e Open Source? Todos estamos aprendendo! Veja este tutorial para entender melhor como contribuir em um projeto!

Detalhes e informações importantes

  1. O código é feito com HTML, CSS e Javascript apenas! Sim, queremos deixar simples e fácil, para que todos possam entender como o Alvinator funciona, ou melhor ainda, contribuir com suas novas ideias!

  2. Existem várias formas de contribuir com o projeto. Uma delas é vendo as issues e encontrando alguma que queira trabalhar. Lembre-se sempre de pedir para trabalhar nela (fazendo um comentário na issue) para depois ser designado. Dessa forma, evitamos confusões e código/trabalho duplicado!

  3. Viu algum bug ou quer adicionar uma nova feature que não está descrita nas issues? Lembre-se que você pode sempre criar uma issue! Basta descrevê-la e informar que está trabalhando nela 😄.

  4. Estamos todos aprendendo! Se acha que algo pode ser feito de uma melhor forma, apresente seus argumentos e discuta! Não é tolerado qualquer tipo de ofensa ou xingamento. Para mais informações, veja nosso código de conduta.

Submetendo suas mudanças

Sempre que submeter sua pull request, seja o mais descritivo possível das mudanças feitas e da solução empregada. Também seja descritivo em seus commits, com uma breve descrição das mudanças realizadas:

$ git commit -m "Breve descrição do commit"

Padrões de código

Se der uma olhada no código, irá entender a maioria dos "padrões", mas aqui são alguns principais:

  • Indentação sempre com 2 espaços (caso encontre código antigo com indentação errada, sinta-se a vontade para corrigir)
  • Sempre colocar espaços depois de itens de um array ([1, 2, 3], não [1,2,3]), entre operadores (x += 1, não x+=1), e funções (() => { não ()=>{).
  • Comente seu código quando possível. Não é necessário descrever cada linha, mas uma breve descrição de cada função ou operação ajuda na compreensão.