Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 2.93 KB

CONTRIBUTING.md

File metadata and controls

68 lines (44 loc) · 2.93 KB

Contribuindo para o Raspador de discursos de deputados federais

Existem algumas maneiras de contribuir com este projeto. Você pode contribuir atualizando a documentação, sugerindo melhorias ou melhorando a base de códigos.

Alguns exemplos: adicionar testes a base de códigos atual, alterar o README para incluir algo novo que você acha necessário ou sugerir uma melhoria que não se encontra no aplicativo.

Código de conduta

Nós acreditamos e seguimos as regras dispostas em nosso código de conduta para garantir um ambiente em que todos se sintam bem-vindos. Ao participar do projeto, seja submetendo sugestoes ou melhorias, você concorda com o nosso código de conduta. Recomendamos que você o leia antes de participar.

Criando uma issue

O GitHub oferece uma ferramenta, dentre outras, para buscar confirmação de mudanças no projeto que você gostaria de propor através de um pull request. Uma forma elegante de iniciar uma conversa conosco antes de tocar na base de código ou documentação.

Se você encontrou algum bug ou quer adicionar uma nova funcionalidade, siga as seguintes instruções.

Se depois de verificar a lista das issues (abertas e fechadas), tem certeza de que se trata de algo novo ou não reportado anteriormente, crie uma nova issue no GitHub. Lembre-se de adicionar o máximo de informações relevantes o possível para que pelo menos sejamos capazes de reproduzí-lo.

Em se tratando de uma nova funcionalidade, adicione informações relevantes sobre uma feature que você gostaria que estivesse no aplicativo.

Contribuindo com a base de código

Requisitos

Configurando o projeto local

  1. Crie um fork do projeto
  2. Clone o projeto:
git clone https://github.com/<SEU_USUARIO_GITHUB>/raspador-discursos-camara

ou

git clone https://github.com/<SEU_USUARIO_GITHUB>/raspador-discursos-camara.git

Dentro do diretório raspador-discursos-camara, se encontra o código fonte do projeto.

Criando um branch e adicionando suas alterações

Assim que estiver satisfeito com suas alterações, crie um novo branch e as adicione.

git checkout -b nome-do-meu-branch

Com o branch criado, adicione as alterações com os comandos abaixo:

git add .
git commit -m "comentario sobre o que foi alterado"

Envie suas alterações executando:

git push origin nome-do-meu-branch

Pronto. As suas alterações foram enviadas para o seu fork do projeto.

Criando um pull request

Como essa parte e mais visual, siga as instruções para criar um pull request do seu fork para o branch master do nosso projeto.

Aguarde pela avaliação da pull request.