README - Guia de Contribuição.md

Contribuindo para o Projeto Pauliceia

Toda ajuda é bem-vinda! Todos que quiserem contribuir para o andamento do Pauliceia precisam apenas ler este pequeno guia.

1- Realizando o fork no repositório

A primeira coisa que você precisa fazer é forkar o nosso repositório. Ao fazer isso, uma cópia dele será adicionada à sua conta no Github.

2- Set up local repository

Agora, você precisará de um repositório local do projeto. Para isso será necessário que tenha a chave SSH do seu repositório. Para isso, primeiro clique em Code.

Depois, clique em SSH.

Copie a URL gerada e clone o seu repositório localmente com o comando "git clone " no terminal do seu computador, como no exemplo abaixo:

git clone [email protected]:stackOvercrow/pauliceia.git

Ao clonar, o repositório remoto no Github será automaticamente configurado como o repositório remoto do seu ambiente.

4- Baixando as dependências do projeto

Abra um terminal na pasta do seu repositório local e digite o seguinte comando:

npm install 

Este comando instalará automaticamente as dependências do Pauliceia. Depois, vá para o diretório "config" e crie uma cópia do arquivo "prod.env.js.EXAMPLE" no mesmo local e renomeie-o removendo o ".EXAMPLE" de seu nome. O resultado esperado será:

5- Fazendo o servidor funcionar

Agora, para fazer o servidor funcionar, digite no terminal:

npm run dev 

Depois que a aplicação terminar de ser construída, seu terminal deverá parecer com o da foto abaixo.

6- Desenvolvendo a sua feature

É imprescindível que o seu código (comentários, variáveis, métodos e funções) esteja em inglês e siga os padrões de indentação e estruturação de outras partes do projeto. Dessa forma, será mais fácil e rápido entender a sua contribuição, além de manter a identidade do código do Pauliceia.

7- Enviando suas mudanças para o repositório remoto

Quando você terminar de desenvolver a sua funcionalidade, abra um terminal na pasta que funciona como seu repositório local. Use os comandos abaixo para adicionar seus arquivos, crie um commit (o nome dele deverá seguir o Conventional Commits:) e envie-o para seu repositório remoto.

git add .
git commit -m "Nome do Commit"
git push origin master

8- Abrindo um Pull Request

Para abrir um Pull Request para o repositório do Pauliceia, clique em Contribuir.

Então, clique em Open Pull Request.

Ao criar seu Pull Request, o Github irá pedir um título e uma descrição. É importante enfatizar que:

1. Os nomes de seus Pull Requests devem seguir Conventional Commits;
2. Pull Requests precisam ser feitos para a branch "develop", como é mostrado na imagem.

Agora é só esperar que o seu Pull Request seja verificado por um de nosso membros.