Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

63 lines (41 loc) · 3.63 KB

Como contribuir para esse projeto

Você achou um bug?

  • Tenha certeza que o bug já não foi reportado procurando no GitHub em Issues.

  • Se você não encontrou nenhuma Issue aberta para esse problema, abra uma nova. Tenha certeza de incluir um título e descrição claros, use um dos templates - provendo ao menos a informação requerida - e uma amostra de código ou uma screenshot mostrando o problema.

Você corrigiu um bug?

  • Abra um novo Pull Request no GitHub com a correção.

  • Garanta que o PR descreva claramento o problema e solução, que contenha toda a informação necessária para o template e que esteja relacionado a pelo menos uma Issue.

  • Tenha certeza de que segue a política de commit

Você planeja adicionar uma nova funcionalidade ou mudar uma existente?

  • Primeiro, cheque na lista de Issues e tenha certeza de que ninguém está implementando a funcionalidade que você planeja criar. Caso não exista, você pode prosseguir.

  • Abra uma nova Issue com as informações necessárias ao template, seguindo o padrão User Story, Feature ou Epic.

Contribuindo

1. Configurando o repositório

Para poder contribuir, você precisa fazer um fork do repositório Estudeplus

Em seguida clone o fork para sua máquina local:

git clone https://github.com/user-name/estudeplus.git

Você deve também deve adicionar o repositório oficial do Estudeplus como um dos repositórios remotos:

git remote add estudeplus https://github.com/desenho-2019-1/estudeplus.git

2. Configure o ambiente de desenvolvimento

Siga os passos definidos no README para configuração do ambiente de desenvolvimento.

3. Trabalhando em uma funcionalidade

Quando estiver trabalhando em uma funcionalidade, crie uma nova branch seguindo a política de branches, e tome como base a branch master do repositório oficial(estudeplus/master):

git checkout -b feat#59/new_login_option estudeplus/master

Faça as alterações necessárias e realize os commits, seguindo a política de commits.

Após finalizar os commits envie as alterações para o seu repositório remoto:

git push origin feat#59/new_login_option

4. Pull Request

Acesse o seu fork do repositório oficial (ex: https://github.com/user-name/estudeplus) e clique em "Pull Requests" no painel. Na próxima página, pressione "New pull request" no canto superior direito.

Selecione como base a branch develop do repositório oficial(desenho-2019-1/estudeplus) e compare com a branch referente a nova funcionalidade, por exemplo feat#59/new_login_option, em seguida clique em "Create new pull request".

Preencha o template sugerido com as informações necessárias para descrever a mudança proposta, conecte o Pull Request a Issue relacionada e confirme a criação do Pull Request.

O seu Pull Request será analizado e a equipe responsável pelo projeto garante prover o feedback mais claro possível para sua proposta de mudança.

Com ❤️,

O time Estude+.