Skip to content

Instantly share code, notes, and snippets.

@hi-hi-ray
Last active October 9, 2018 21:10
Show Gist options
  • Save hi-hi-ray/8d62d2b9d505e929f311b406c95b0ee0 to your computer and use it in GitHub Desktop.
Save hi-hi-ray/8d62d2b9d505e929f311b406c95b0ee0 to your computer and use it in GitHub Desktop.

GitHub 101

Deixando sua documentação bonita.

Emoticons e seus significados em um commit

  • 🎨 Ao melhorar o formato / estrutura do código
  • 🚀 Ao melhorar o desempenho
  • ✏️ Ao escrever documentos
  • 💡 Nova ideia
  • 🚧 Trabalho em andamento
  • ➕ Ao adicionar recurso
  • ➖ Ao remover o recurso
  • 🔈 Ao adicionar log
  • 🔇 Ao reduzir o log
  • 🐛 Ao corrigir um bug
  • ✅ Ao adicionar testes
  • 🔒 Quando se lida com segurança
  • ⬆️ Ao atualizar dependências
  • ⬇️ Ao desatualizar dependências
Documentações importantes pra um repositório
Nome Modelo
Readme Documentação básica e principal do seu projeto
Readme com Docker Documentação básica e principal do seu projeto com docker
Contributing Como uma pessoa pode contribuir com seu repositório
License Copyrights do Seu Repositório
Changelog Lista de Mudanças, sejam features ou fixes da sua aplicação
Sabendo se seu repósitorio * pode ser open source

Requisitos para projetos open source

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment