Contribuindo
Contribuindo
Seção intitulada “Contribuindo”Contribuições são bem-vindas! Por favor, siga estes passos:
Como Contribuir
Seção intitulada “Como Contribuir”- Faça fork do repositório
- Crie uma branch de feature (
git checkout -b feature/amazing-feature) - Faça commit das suas alterações (
git commit -m 'feat: add amazing feature') - Envie para a branch (
git push origin feature/amazing-feature) - Abra um Pull Request
Configuração do Desenvolvimento
Seção intitulada “Configuração do Desenvolvimento”git clone https://github.com/LuiggiVal08/toon-memory.gitcd toon-memorynpm installnpm run buildnpm testEstrutura do Projeto
Seção intitulada “Estrutura do Projeto”toon-memory/├── src/│ ├── bin/ # Ponto de entrada (CLI + roteador MCP)│ ├── cli/ # Comandos CLI (setup, capture, session-start)│ ├── lib/ # Bibliotecas principais (graph, quality, sessions, context, vocab, lock)│ └── mcp/ # Servidor MCP (35 ferramentas, 4 recursos)├── tests/ # Testes unitários (vitest)├── docs/ # Site de documentação (Astro + Starlight)├── bin/ # Saída do build (ponto de entrada)├── mcp/ # Saída do build (servidor MCP)└── package.jsonScripts
Seção intitulada “Scripts”npm run build # Buildar tudonpm run build:cli # Buildar CLInpm run build:mcp # Buildar servidor MCPnpm test # Executar testesnpm run test:watch # Executar testes no modo watchEstilo de Código
Seção intitulada “Estilo de Código”- TypeScript com modo estrito
- Indentação de 2 espaços
- camelCase para variáveis/funções
- PascalCase para classes
Diretrizes para Pull Requests
Seção intitulada “Diretrizes para Pull Requests”- Escreva mensagens de commit claras
- Adicione testes para novas funcionalidades
- Atualize a documentação se necessário
- Siga o estilo de código existente
Código de Conduta
Seção intitulada “Código de Conduta”Por favor, leia nosso Código de Conduta antes de contribuir.