✏️ Guia de Contribuição

🚀 Guia de Contribuição para o Projeto Íris

Estamos felizes que você deseja contribuir para o projeto Íris. Este guia o ajudará a entender como fazer uma pull request para o repositório. Muito obrigado pela sua participação!

📚 Passos para Contribuir

1. Fork do Repositório

   • Clique no botão "Fork" no canto superior direito da página inicial da Íris aqui no GitHub para criar uma cópia do repositório em sua conta.
   • Você também pode fazer uma Fork clicando aqui.

2. Clone o SEU Repositório

   • Abra o terminal (linha de comando).
   • Clone o repositório em sua máquina local com o comando:

     git clone https://github.com/SEU_USUÁRIO/nome-do-repositório.git

   • Substitua SEU_USUÁRIO e nome-do-repositório pelos seus detalhes.

3. Crie uma Branch

   • Crie uma nova branch para sua contribuição com o comando:

     git checkout -b nome-da-sua-branch

   • Dê um nome curto para sua branch, de preferência, como 'main'.

4. Faça Suas Alterações

   • Faça as alterações e adições necessárias no código.
   • Se estiver usando o Visual Studio Code, instale as dependências do projeto com o comando:

     npm i

   • Feito isso, instale o eslint no Visual Studio Code pela marketplace, isso habilitará o ESLint para ajudá-lo a manter um código limpo.

5. Commit das Alterações

   • Adicione suas alterações ao commit com o comando:

     git add .
     git commit -m "Descrição CURTA das suas alterações"

6. Push das Alterações

   • Envie suas alterações para o seu repositório no GitHub com o comando:

     git push origin nome-da-sua-branch

7. Crie uma Pull Request

   • Volte para a página do Projeto Íris no GitHub, aperte em pull requests.
   • Você verá um botão "Compare & pull request". Clique nele.

8. Descreva sua Pull Request

   • Forneça uma descrição DETALHADA do que você fez e do motivo das alterações.

9. Revisão e Merge

   • Após a análise de @KillovSky, suas alterações serão mescladas no repositório principal, desde que sejam aprovadas.

✨ Dicas para uma Boa Pull Request

• Mantenha a Pull Request focada em uma única tarefa ou correção, de preferência, comandos em formato de plugin como os atuais.
• Forneça uma descrição clara do que foi feito.
• Mantenha seu código limpo e siga as diretrizes do projeto, como comentários claros e breves do que está acontecendo em cada linha, não exagere.
• Certifique-se de que os testes foram realizados antes de enviar a Pull Request e que ela está funcional.
• Insira os diálogos em todos os idiomas, você pode traduzir usando google tradutor, mas certifique-se de traduzir de volta, para ver se a frase está fazendo sentido.
• Melhorias pequenas podem ser adiadas para serem postadas junto a correções maiores.
• Se estiver em dúvida, venha para nossas redes sociais, estaremos de prontidão para oferecer ajuda a criar sua pull request!
• Alterações menores, como a adição de apenas alguns diálogos, podem ter a permissão de pull request negada se não forem consideradas urgentes ou essenciais no momento.
• Se estiver editando os idiomas, é preferível inserir um número significativo de diálogos em vez de quantidades mínimas. Isso aumenta a relevância e a importância da contribuição.

❤️ Obrigado por contribuir! ❤️