Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 4.04 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 4.04 KB
Raw

Guia de Contribuição

Nota para quem não falar português

Note for non-Portuguese Speaking Contributors

This project was made open source in order to encourage contributions from Portuguese students enrolled in the "As Raparigas do Código" project and, as such, will be mostly written in Portuguese.

However, if you'd like to contribute, we will accept PRs in English.

Thank you!

Como Contribuir

  1. Vai até à tab de "Issues" e escolhe um issue que tenha a label Hacktoberfest:

    Tab das issues

    • Se estás indecisa, começa com os Issues com a label good first issue, que são acessíveis a pessoas com todo o tipo de experiência.

  2. Deixa um comentário no issue que queres resolver:

    • Tenta deixar uma pequena previsão de quando vais conseguir começar a resolver o problema, e indica se precisas de ajuda, para que possamos garantir que os issues não são abandonados;
    • Garante que não és atribuída a mais do que um issue ao mesmo tempo;

  3. Um dos mentores atribuirá esse issue ao utilizador com o primeiro comentário;

  4. Quando o issue te for atribuído, faz fork do projecto - vê aqui como;

  5. Cria um novo branch no projecto que bifurcaste - vê aqui como;

    • Garante que lhe dás um nome descritivo, ex.: "adicionar-botao-home"

  6. Tenta fazer commits com regularidade e escreve mensagens descritivas, ex.: "adiciona botão azul à página inicial";

  7. Quando terminares o teu trabalho faz um Pull Request (PR) para o branch main do repositório original - vê aqui como;

  8. Quando criares o novo PR podes ver as tuas alterações no ambiente de "preview" gerado pelo Vercel -> clicka no link e vê como é que o site vai ficar com a tua alteração

    preview do site numa pull request

  9. O teu PR será revisto por um dos mentores, e contará como uma contribuição para o Hacktoberfest se:

    • for "merged"; ou
    • tiver tag "hacktoberfest-accepted"

Nota: por vezes podemos não fazer "merge" de um PR porque não se enquadra no "roadmap" que temos para o projeto mas ainda assim queremos premiar o trabalho feito e, como tal, atribuímos-lhe a tag hacktoberfest-accepted, que também conta para o Hacktoberfest.

Podes ler mais sobre a participação no Hacktoberfest aqui.

Importante

Lembramos que não precisas apenas de resolver issues já identificados, podes também sugerir novas funcionalidades, reportar bugs, e dizer-nos caso tenhas ideias para o projecto, através da criação de um novo Issue.

Finalmente, caso tenhas qualquer dúvida durante a tua contribuição, deixa a tua dúvida na Issue ou no Discord, estamos aqui para te apoiar!

Intruções para correr o projeto

  1. Clona o projecto para o teu computador usando o Github Desktop ou a linha de comandos/terminal:
~ git clone https://github.com/As-Raparigas-do-Codigo/ardc-website.git
  1. Abre o projeto no teu editor de código (IDE) favorito;
  2. Instala a ferramente npm caso não a tiveres instalada;
  3. Abre um terminal na pasta do projecto;
  4. Usa o commando no terminal para instalar dependências do projeto com npm install;
  5. Depois de instalares as dependencias podes correr o projeto no terminal com npm start.