Advertisement
mariovalney

CONTRIBUTING.md

Aug 22nd, 2018
84
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 2.30 KB | None | 0 0
  1. ## Guia de Commit
  2.  
  3. Padronizamos a forma de escrita dos commits. O objetivo é criar **mensagens mais legíveis** e que passem facilmente o histórico do projeto.
  4.  
  5. * Seja sucinto, porém é melhor sobrar do que faltar.
  6. * Escreva sempre título e se necessário (geralmente é) uma mensagem explicando o que foi feito.
  7. * Indicar o motivo é melhor do que o que foi feito no código, já que temos o diff para esse histórico.
  8. * Idioma padronizado: **Português**.
  9.  
  10. ### Formato da mensagem do commit
  11.  
  12. ````
  13. [Tag] Título Relevante do Commit
  14.  
  15. Mensagem do commit. Geralmente explicando o que foi alterado,
  16. removido ou adicionado e possíveis detalhes de implementação
  17. que possam ser usados pela equipe em desenvolvimentos futuros.
  18. ````
  19.  
  20. ### Tabela de Tags
  21.  
  22. * **Feat:** Uma nova funcionalidade
  23. * **Fix:** Correção de algum bug
  24. * **Style:** Mudanças que não alteram o significado do código (white-space, formatação, ponto-e-virgula faltando...)
  25. * **Refact:** Alteração do código que não corrige ou adiciona nada.
  26. * **Docs:** Relacionado a documentações
  27. * **Git:** Relacionado ao versionamento
  28. * **Test:** Relacionado a testes
  29.  
  30. ## Git
  31.  
  32. Além do Guia de Commit, padronizamos o `git rebase master` antes do merge, para um histórico mais fácil de ser visualizado.
  33.  
  34. Também temos o branch `master` como protegido, sendo impossível forçar um pull. Além dele, qualquer branch com `*_master` segue essa regra, então desenvolvedores podem criar "outros masters" para tarefas diversas antes de fazer o merge com a master.
  35.  
  36. ## Desenvolvimento
  37.  
  38. Informações sobre o desenvolvimento.
  39.  
  40. Por exemplo, podemos explicar como instalar e utilizar o Gulp/Grunt e/ou informações particulares da ferramenta, CMS, SO, etc.
  41.  
  42. No root do diretório, rode:
  43.  
  44. ```
  45. npm install
  46.  
  47. ```
  48.  
  49. [Instale o Gulp](https://github.com/gulpjs/gulp/blob/v3.9.1/docs/getting-started.md), caso não tenha:
  50.  
  51. ```
  52. npm install --global gulp-cli
  53. ```
  54.  
  55. Rode as tarefas necessárias (mais detalhes no `gulpfile.js`).
  56.  
  57. ### Gulp
  58.  
  59. Utilize `gulp default` para rodar as tarefas de build do projeto.
  60.  
  61. Utilize `gulp watch` para o desenvolvimento com o BrowserSync.
  62.  
  63. Basta rodar o comando e uma janela com `localhost:8080` irá abrir. Quais quer alterações nos arquivos `.less` que estão sendo "ouvidos" irá ser reproduzida nessa nova aba.
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement