Pular para conteúdo

Guia de Contribuição

O Tainacan é um projeto open source colaborativo, que permite a participação de desenvolvedores, pesquisadores e usuários da comunidade. Sua evolução depende diretamente da contribuição ativa desses participantes, seja por meio do desenvolvimento de código, da documentação ou da interação nos canais da comunidade.

A contribuição no Tainacan é organizada em dois pilares principais: desenvolvimento técnico (GitHub) e colaboração comunitária (fórum).


Canais de Contribuição

🔹 GitHub (Desenvolvimento e Código)

O principal canal técnico do Tainacan é o GitHub, onde está hospedado o código-fonte do projeto.

Por meio dele, é possível:

  • Reportar bugs (Issues)
  • Sugerir melhorias
  • Desenvolver novas funcionalidades
  • Enviar contribuições via Pull Requests

Fluxo de contribuição:

  1. Realizar um fork do repositório oficial
  2. Criar uma branch para a modificação
  3. Implementar a alteração desejada
  4. Realizar testes locais
  5. Enviar um Pull Request para revisão

Esse fluxo garante organização, rastreabilidade e qualidade no desenvolvimento do projeto.

Diretrizes de contribuição

  • Política linguística: Embora o Tainacan seja um projeto brasileiro, é adotado o inglês como idioma principal para assuntos de desenvolvimento. É permitido escrever comentários em português em issues e pull requests, desde que você forneça uma tradução em inglês dos seus comentários. É expressamente proibido escrever comentários em português em commits. Comentários sobre o código-fonte e nomes de variáveis ​​também devem ser escritos apenas em inglês.

  • Modelo de Issues: Uma issue é uma discussão dentro do repositório GitHub do projeto, focada em debater bugs, solicitações de recursos ou erros que possam ser encontrados. Para reunir o máximo de informações possível e organizar as discussões de forma mais clara e fácil de pesquisar, este repositório possui alguns modelos para as issues mais comuns:

  • Bug report: Se algo não estiver funcionando corretamente no Tainacan.

  • Feature request: Ideias de recurso para sugestão de desenvolvimento.

Colaboração na Wiki

Para colaborar com a Wiki do projeto siga o Guia do Tainacan.


🔹 Fórum da Comunidade (Discourse)

O Tainacan mantém um fórum oficial para interação e organização da comunidade:

👉 https://tainacan.discourse.group/

O fórum não se limita apenas ao suporte, sendo um dos principais espaços de comunicação do projeto.

Por meio dele, é possível:

  • Tirar dúvidas sobre o uso da plataforma
  • Reportar erros e comportamentos inesperados
  • Sugerir melhorias e novas funcionalidades
  • Discutir aspectos técnicos do sistema
  • Compartilhar experiências e casos de uso
  • Acompanhar lançamentos e anúncios oficiais
  • Participar de pesquisas e oportunidades

Diferente do GitHub, que é voltado principalmente para o desenvolvimento de código, o fórum atua como um ambiente mais amplo de colaboração, abrangendo suporte, comunicação, discussão técnica e interação entre usuários e desenvolvedores.

Além disso, a estrutura organizada em categorias permite separar claramente diferentes tipos de interação, como suporte, desenvolvimento e divulgação, tornando o fórum um componente essencial do ecossistema do Tainacan.

Estrutura do Fórum

O fórum é organizado em categorias que ajudam a direcionar corretamente as discussões:

🆘 Suporte

Categoria voltada para apoio geral aos usuários.

Inclui:

  • Dúvidas sobre uso
  • Relatos de problemas
  • Solicitações de ajuda

Subcategorias:

- ❓ Dúvidas → Questões gerais  
- 🐞 Erros → Problemas e falhas  
- 💡 Sugestões → Ideias de melhoria  

💻 Desenvolvimento

Categoria destinada a discussões técnicas.

Inclui:

  • Implementação de funcionalidades
  • Estrutura do sistema
  • Evolução do projeto

Subcategorias:

- 🚀 Novas features e melhorias  
- 🤝 Contribuições  
- 🧩 Modelagem  

🌐 Geral

Espaço para discussões que não se encaixam em outras categorias.


📢 Divulgação

Categoria para anúncios oficiais.

Inclui:

- Lançamentos  
- Avisos  
- Pesquisas  
- Oportunidades

Os conteúdos publicados aqui podem ser enviados por e-mail aos usuários.


📂 Sem categoria

Utilizada para tópicos não classificados.


🛠️ Feedback do Site

Voltada para melhorias do próprio fórum.

Inclui:

  • Sugestões de organização
  • Melhorias de usabilidade

Tipos de Contribuição

A contribuição no Tainacan pode ocorrer de diversas formas:

💻 Desenvolvimento

  • Criação de novas funcionalidades
  • Correção de bugs
  • Otimização de desempenho

📚 Documentação

  • Criação de guias e tutoriais
  • Tradução de conteúdos
  • Melhoria da documentação existente

🧪 Testes

  • Validação de funcionalidades
  • Identificação de erros
  • Testes em diferentes ambientes

💬 Comunidade

  • Participação no fórum
  • Apoio a outros usuários
  • Compartilhamento de soluções

Boas Práticas

Para contribuir de forma eficiente, recomenda-se:

  • Seguir os padrões de código do projeto
  • Criar commits claros e descritivos
  • Testar antes de enviar contribuições
  • Documentar alterações realizadas
  • Verificar se já existe uma issue relacionada
  • Adotar o inglês para comentários de desenvolvimento

Histórico de Versões

Versão Data Descrição Autor(es)
1.0 12/04/2026 Criação da pagina conheça o Tainacan Mayara Alves
1.1 17/04/2026 Atualiza informações de contribuição Raquel Eucaria