Skip to content

Latest commit

 

History

History
133 lines (97 loc) · 4.04 KB

CONTRIBUTING.md

File metadata and controls

133 lines (97 loc) · 4.04 KB

contribute

👋 Bem-vindo(a)!

Se você chegou até aqui tenho certeza de que você tem interesse tanto em RPG quanto em programação, esse é o lugar certo para isso. Antes de começar a contribuir com o nosso projeto, leia esse guia para você ficar por dentro do nosso sistema e colaborar da melhor forma possível.


🤔 Como contribuir?

Você pode colocar uma feature nova em prática, uma ideia de melhoria ou escolher uma das issues em aberto para solucioná-la.


📁 Configurando o repositório

1º) Fork do Repositório: Faça um Fork para levar uma cópia do repositório para a sua conta. Assim você pode fazer suas alterações sem influenciar o repositório principal.

2º) Clone o repositório:

git clone https://github.com/SuaConta/ForgeSheets.git

3º) Crie sua Branch:

git checkout -b minha-nova-funcionalidade

💻 Configurando o ambiente de desenvolvimento

1º) Entre no Diretório do Projeto:

cd ForgeSheets

2º) Crie um Ambiente Virtual:

python -m venv venv

3º) Ative o Ambiente Virtual:

Windows: venv\Scripts\activate
Linux/Mac: source venv/bin/activate

4º) Instale as Dependências:

pip install -r requirements.txt

5º) Aplique as Migrations (Criar o Banco de Dados):

python manage.py migrate

6º) Rode o Servidor:

python manage.py runserver

OBS:

Caso queira garantir que o código adicionado não quebre outras partes da aplicação, rode os testes existentes e, se necessário, crie novos testes. Para fazer isto:

1º) Baixe o Node na sua versão LTS:

2º) Instale as dependências:

npm ci

2º) Rode os testes com:

npx cypress run

🛰️ Submetendo suas Alterações

Abra um Pull Request com uma descrição detalhada das alterações realizadas.

1º) No repositório que você deu fork, clique em Contribute:

2º) Depois clique em Open pull request:

3º) Agora selecione o repositório que você deu fork e a branch que você fez suas alterações:

4º) Então, para criar seu PR, clique em Create pull request:

5º) Por fim....

Nós da </Taverna> iremos avaliar a sua submissão e caso algo esteja incompatível com nosso projeto, entraremos em contato para revisarmos o seu código.


❤️ Obrigado por Contribuir!

Temos certeza de que a comunidade Open-Source têm muito a acrescentar no nosso projeto, estamos ansiosos para receber as sugestões de melhorias de vocês!




Se tiver dúvidas, sinta-se a vontade para entrar em contato com a gente: taverna.hub@gmail.com