Thanks for your interest in GolemBot! Here's how to get involved.
- Node.js >= 22
- pnpm >= 9
pnpm install
pnpm run build
pnpm run test- Fork this repository
- Create your feature branch (
git checkout -b feat/my-feature) - Commit your changes (
git commit -m 'feat: add some feature') - Push to the branch (
git push origin feat/my-feature) - Open a Pull Request
- TypeScript strict mode
- Use clear, self-explanatory function names — code should be readable without comments
- All exported public APIs must have JSDoc documentation
- New features must include tests
Follow Conventional Commits:
feat:New featurefix:Bug fixdocs:Documentation updaterefactor:Refactoringtest:Testschore:Build / toolchain
src/
├── index.ts # Public API — createAssistant()
├── engine.ts # AgentEngine interface and engine implementations
├── workspace.ts # Configuration, Skill scanning
├── session.ts # Session management
├── server.ts # HTTP SSE service
├── gateway.ts # Long-running Gateway service + IM channels
├── channel.ts # Channel adapter interface
├── channels/ # Feishu / DingTalk / WeCom adapters
└── cli.ts # CLI entry point
- Implement the
AgentEngineinterface insrc/engine.ts - Register it in the
createEngine()factory function - Add unit tests (parsing logic) and e2e tests
- Update the engine comparison table in README
- Implement the
ChannelAdapterinterface insrc/channels/ - Register it in the adapter factory in
src/gateway.ts - Update the
GolemConfigtype and configuration docs - Add the IM SDK as an optional peerDependency
All contributions are released under the MIT License.