Kinotic OS
Contributing
How to contribute to the Kinotic OS project.
Overview
We welcome contributions to Kinotic OS. This guide covers the repository structure, build process, and contribution workflow.
Repository Structure
| Directory | Description |
|---|---|
kinotic-core/ | Java/Kotlin backend (Spring Boot) — RPC gateway, service registry, authentication, Cedar policy engine |
kinotic-domain/ | Domain model and OS API services — application, project, and cluster management |
kinotic-js/ | TypeScript SDK workspace (Bun) — @kinotic-ai/core, @kinotic-ai/persistence, and related packages |
kinotic-frontend/ | Vue.js admin UI — the Kinotic OS dashboard |
website/ | Documentation site (Docus/Nuxt) |
deployment/ | Helm charts, Docker Compose, Terraform configurations |
Building
Java/Kotlin Backend
./gradlew build
TypeScript SDK
cd kinotic-js
bun install
bun run build
Website
cd website
bun install
bun run dev
Testing
Java/Kotlin
./gradlew test
TypeScript (Vitest)
cd kinotic-js
bun test
Submitting Changes
- Fork the repository and create a feature branch from
develop - Make your changes with clear, descriptive commit messages
- Ensure all tests pass before submitting
- Submit a pull request against the
developbranch