Pular para o conteúdo principal

Como contribuir para o projeto

Toda ajuda é muito bem-vinda no desenvolvimento do VixeText! Seja para corrigir erros, adicionar novas funcionalidades, melhorar o template ou até mesmo contribuir com a documentação, sua participação é importante para que o projeto continue evoluindo.

O código-fonte e os templates do VixeText estão disponíveis publicamente no GitHub:

Formas de contribuir​

  1. Melhorias no template

    • Criar novos layouts ou ajustar o design existente.
    • Adicionar suporte a novas normas acadêmicas.
    • Otimizar o código para melhor desempenho.

  2. Documentação

    • Corrigir erros gramaticais ou ortográficos.
    • Adicionar explicações mais detalhadas.
    • Criar tutoriais e exemplos de uso.

  3. Correção de bugs

    • Identificar e reportar problemas encontrados.
    • Enviar pull requests com as correções.

  4. Sugestões de melhorias

    • Criar issues com novas ideias e funcionalidades desejadas.

Passos para contribuir​

  1. Faça um fork do repositório no GitHub.

  2. Clone o seu fork para o seu computador.

  3. Crie uma nova branch para suas alterações:

    git checkout -b minha-contribuicao

  4. Realize as modificações desejadas.

  5. Envie suas alterações para o seu fork:

    git push origin minha-contribuicao

  6. Abra um Pull Request no repositório oficial, explicando suas mudanças.

Dicas para contribuir​

  • Sempre mantenha sua branch atualizada com a main do repositório oficial.
  • Escreva mensagens de commit claras e objetivas.
  • Teste suas alterações antes de enviar.
  • Seja respeitoso e colaborativo nas discussões do GitHub.

Contribuir para o VixeText é uma ótima forma de aprender, compartilhar conhecimento e ajudar outros acadêmicos e desenvolvedores. Cada contribuição, por menor que pareça, faz diferença no crescimento do projeto!