|
| 1 | +# Contributing to AI MemoryCore |
| 2 | + |
| 3 | +Thanks for your interest! Here's how to contribute. |
| 4 | + |
| 5 | +## Quick Setup |
| 6 | + |
| 7 | +```bash |
| 8 | +git clone https://github.com/Kiyoraka/Project-AI-MemoryCore.git |
| 9 | +cd Project-AI-MemoryCore |
| 10 | +npm install |
| 11 | +npm run dev |
| 12 | +``` |
| 13 | + |
| 14 | +## Development |
| 15 | + |
| 16 | +```bash |
| 17 | +npm run dev # Start dev server (tsx watch) |
| 18 | +npm run build # TypeScript compile |
| 19 | +npm run test # Run tests |
| 20 | +npm run cli # Run CLI commands |
| 21 | +``` |
| 22 | + |
| 23 | +## Pull Requests |
| 24 | + |
| 25 | +1. Fork the repo and create a branch from `main` |
| 26 | +2. Make your changes with clear commit messages |
| 27 | +3. Add tests if you're adding new features |
| 28 | +4. Ensure `npm run build` passes |
| 29 | +5. Open a PR with a description of what you changed and why |
| 30 | + |
| 31 | +## Issues |
| 32 | + |
| 33 | +- **Bug reports**: Include steps to reproduce, expected vs actual behavior |
| 34 | +- **Feature requests**: Describe the use case and proposed solution |
| 35 | +- **Questions**: Use GitHub Discussions if available, otherwise open an issue |
| 36 | + |
| 37 | +## Code Style |
| 38 | + |
| 39 | +- TypeScript strict mode |
| 40 | +- Use Zod for input validation |
| 41 | +- Keep functions focused and small |
| 42 | +- Add JSDoc comments for public APIs |
| 43 | + |
| 44 | +## Architecture |
| 45 | + |
| 46 | +``` |
| 47 | +src/ |
| 48 | +├── server.ts # Entry point |
| 49 | +├── api.ts # Fastify routes |
| 50 | +├── mcp.ts # MCP server |
| 51 | +├── service.ts # Business logic |
| 52 | +├── storage.ts # SQLite layer |
| 53 | +├── schemas.ts # Zod schemas |
| 54 | +├── config.ts # Env config |
| 55 | +└── cli.ts # CLI |
| 56 | +``` |
| 57 | + |
| 58 | +## License |
| 59 | + |
| 60 | +By contributing, you agree that your contributions will be licensed under the MIT License. |
0 commit comments