Skip to content

Latest commit

 

History

History
96 lines (53 loc) · 4.46 KB

CONTRIBUTING.md

File metadata and controls

96 lines (53 loc) · 4.46 KB

Bem-vido ao Guia de Contribuição do grupo Pizy

Guia do Novo Contribuidor

Para obter uma visão geral do projeto, leia o README. Aqui estão alguns recursos para ajudá-lo a começar com as contribuições de código aberto:

Documentações
Tutoriais

Começando a contribuir

Issues

Criando uma nova issue

Se você identificar um problema com o repositório, pesquise se o problema já existe. Se um problema relacionado não existir, você pode abrir uma nova issue.

Resolvendo uma issue

Examine nossos problemas existentes para encontrar um que lhe interesse. Você pode restringir a pesquisa usando rótulos para filtrar.

Como regra geral, não atribuímos as issues a ninguém além dos mantenedores. Se você encontrar um problema para resolver, poderá abrir um PR com uma correção.

Fazendo mudanças

Fazendo alterações na documentação

Clique em Fazer uma contribuição na parte inferior de qualquer página de documentação para fazer pequenas alterações, como erro de digitação, correção de frase ou link quebrado. Isso leva você ao arquivo .md onde você pode realizazr suas alterações e solicitar um pull request para revisão.

Fazendo alterações no código

Requerimentos
  1. Fork no repositório.
  • Usando a linha de comando:
    • Dê um fork no repositório para que você possa fazer suas alterações sem afetar o projeto original até que você esteja pronto para dar merge.

  1. Instale ou atualize o Node.js, até a versão especificada no .tool-version.

  2. Crie uma nova branch a partir da dev e comece a relizar suas mudanças.

Realizando commits

  • Atualmente seguimos o padrão de commits abaixo:

  • chore - atualizações de tarefas.

  • feat- novo recurso.

  • fix - solucionando um problema.

  • docs - mudanças na documentação.

  • test - alterações em testes.

  • build - arquivos de build.

  • deps - arquivos de dependências.

  • perf - performance.

  • style - formatações de código.

  • refactor - refatorações.

  • ci - integração contínua.

Pull Request

Quando terminar as alterações, crie uma solicitação de pull request, também conhecida como PR.

  • Não se esqueça de atribuir o PR a uma issue se você estiver resolvendo uma.

  • Habilite o checkbox da opção para habilitar os mantenedores à edição para que a branch possa ser atualizada para o merge. Depois de enviar seu PR, um membro da equipe revisará sua proposta. Podemos fazer perguntas ou solicitar informações adicionais.

  • Nós podemos pedir alterações adicionais antes de dar merge da sua branch, utilizando as alterações sugeridas ou comentários do pull request. Você pode aplicar as alterações sugeridas diretamente por meio da interface gráfica provida pelo Github, assim como pode fazer quaisquer outras alterações em seu fork e, em seguida, confirmá-las em seu branch que será automaticamente atualizado no pull request.

  • Ao atualizar seu PR e aplicar as alterações, marque cada conversa como resolvida.

  • Se tiver algum problema, dê uma olhada nesse tutorial de git para ajudá-lo a resolver conflitos de merge e outros problemas.