Contribuições da Comunidade
O ITsMagic é um motor orientado pela comunidade.
Sua documentação, exemplos e recursos de aprendizado são open source, e todos são bem-vindos para ajudar a melhorá-los.
Esta página explica como você pode contribuir e por que sua participação é importante.
Por que Contribuir?
Ao contribuir, você ajuda a:
- Melhorar a clareza da documentação
- Adicionar tutoriais e exemplos
- Corrigir erros ou informações desatualizadas
- Compartilhar componentes e mecânicas reutilizáveis
- Apoiar novos desenvolvedores
- Fortalecer o ecossistema ITsMagic
Mesmo pequenas mudanças — como corrigir um erro de digitação ou esclarecer um parágrafo — fazem uma grande diferença.
A Documentação é Open Source
O repositório oficial da documentação está hospedado no GitHub:
https://github.com/ITsMagic-Software/Documentation
Você pode:
- Ler todos os arquivos-fonte
- Sugerir melhorias
- Corrigir erros
- Adicionar novas páginas
- Enviar exemplos
Todas as contribuições são feitas através de Pull Requests padrão do GitHub.
Comece Lendo a Documentação
Antes de contribuir, recomendamos fortemente revisar a documentação principal:
- Introdução ao motor
- Sistema de Componentes
- Métodos de ciclo de vida (
start,repeat, etc.) - Exemplos existentes
Ponto de entrada da documentação:
https://itmagic.com.br/documentation/docs/intro/
Compreender esses fundamentos garante que suas contribuições sigam os padrões de design do ITsMagic.
Formas de Ajudar
Melhorar a Documentação
Você pode ajudar:
- Corrigindo gramática ou ortografia
- Esclarecendo explicações confusas
- Adicionando comentários em exemplos de código
- Criando tutoriais para iniciantes
- Expandindo páginas existentes
Se algo parece confuso para você, provavelmente também é para outras pessoas.
Adicionar Exemplos
Exemplos são uma das contribuições mais valiosas.
Você pode enviar:
- Componentes de gameplay
- Sistemas de movimento
- Mecânicas de laser ou armas
- Componentes de UI
- Comportamentos de câmera
- Efeitos visuais
Cada exemplo deve incluir:
- Código limpo e minimalista
- Uma explicação curta
- Qual problema ele resolve
Compartilhar Mecânicas de Jogo
Mecânicas reutilizáveis ajudam desenvolvedores a aprender mais rápido.
Bons candidatos incluem:
- Sistemas de vida
- IA de inimigos
- Controladores de jogador
- Sistemas de interação
- Helpers utilitários
Eles podem futuramente fazer parte dos exemplos oficiais ou do Marketplace.
Reportar Problemas
Se você encontrar um problema:
- Abra uma issue no GitHub
- Descreva claramente o problema
- Inclua código ou screenshots quando possível
Relatórios claros economizam tempo dos mantenedores e contribuidores.
Fluxo de Contribuição
Processo básico:
- Faça um fork do repositório de documentação
- Realize suas alterações
- Commit com uma mensagem clara
- Abra um Pull Request
Nenhuma permissão especial é necessária.
Diretrizes de Contribuição
Por favor, siga estes princípios:
- Mantenha o código simples e legível
- Use padrões oficiais de Componentes do ITsMagic
- Evite imports Java desnecessários
- Explique o porquê, não apenas o o quê
- Assuma que iniciantes estão lendo
Clareza é mais importante que complexidade.
O Que Torna uma Boa Contribuição?
Uma boa contribuição:
- Resolve um problema real
- É fácil de entender
- Usa APIs oficiais do ITsMagic
- Inclui explicações
- Ajuda novos usuários a começarem mais rápido
Você não precisa ser especialista para contribuir.
Aprendeu algo novo? Documente.
Resolveu um problema? Compartilhe.
Ensinar outras pessoas é uma das formas mais rápidas de melhorar o motor.
Comunidade em Primeiro Lugar
O ITsMagic cresce através de seus usuários.
Cada tutorial, exemplo, correção e explicação ajuda a construir um ecossistema mais forte.
Obrigado por fazer parte da comunidade.