Contributing¶
Development Process¶
- Fork the repository
- Create a feature branch
- Make changes
- Run tests
- Submit a pull request
Code Style¶
Go¶
- Use
gofmtfor formatting - Use
golangci-lintfor linting - Follow standard Go conventions
TypeScript¶
- Use TypeScript strict mode
- Use functional components with hooks
- Keep components focused and small
Commit Messages¶
Follow Conventional Commits:
feat: add evaluation history panel
fix: resolve spec save race condition
docs: update installation guide
refactor: extract API client to service
Pull Requests¶
- Keep PRs focused on a single change
- Include tests for new functionality
- Update documentation as needed
- Ensure CI passes
Project Structure¶
Adding a New Component¶
- Create component in
desktop/renderer/src/components/ - Export from
components/index.ts - Add types to
types/index.tsif needed
Adding a New API Endpoint¶
- Add handler in
cmd/daemon/main.go - Add types in
pkg/api/types.go - Add client method in
desktop/renderer/src/services/api.ts