mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-10 08:05:14 +02:00
54 lines
2.4 KiB
Text
54 lines
2.4 KiB
Text
---
|
|
title: Community
|
|
description: Contribute to KTX through code, docs, connectors, and examples.
|
|
---
|
|
|
|
KTX is an open-source context layer for database agents. The project welcomes
|
|
focused contributions that improve setup, integrations, CLI behavior,
|
|
documentation, connector coverage, and examples.
|
|
|
|
## Where to start
|
|
|
|
| Goal | Start here |
|
|
|------|------------|
|
|
| Prepare a local development checkout | [Contributing](/docs/community/contributing#development-setup) |
|
|
| Understand the workspace layout | [Repository structure](/docs/community/contributing#repository-structure) |
|
|
| Run verification before a pull request | [Running tests](/docs/community/contributing#running-tests) |
|
|
| Add a database connector | [Adding a connector](/docs/community/contributing#adding-a-connector) |
|
|
| Update docs for a user-visible CLI or setup change | [PR guidelines](/docs/community/contributing#pr-guidelines) |
|
|
|
|
## Contribution areas
|
|
|
|
| Area | Good first context |
|
|
|------|--------------------|
|
|
| CLI and setup | `packages/cli`, especially setup steps, command definitions, status checks, and smoke tests |
|
|
| Context engine | `packages/context`, including project config, ingest orchestration, and semantic search |
|
|
| Connectors | `packages/connector-*`, plus connector-specific tests and integration docs |
|
|
| Python semantic layer | `python/ktx-sl` for planning and SQL generation |
|
|
| Python daemon | `python/ktx-daemon` for the portable runtime API |
|
|
| Documentation | `docs-site/content/docs` for public docs and `docs-site/tests` for docs behavior |
|
|
|
|
## Development loop
|
|
|
|
```bash
|
|
pnpm install
|
|
uv sync --all-groups
|
|
pnpm run setup:dev
|
|
pnpm run link:dev
|
|
ktx-dev status
|
|
```
|
|
|
|
Use `ktx-dev` for local CLI testing after linking the development binary. Use
|
|
the published `ktx` command when you are testing the released package in a
|
|
separate analytics project.
|
|
|
|
## Before submitting
|
|
|
|
1. Keep the change focused on one behavior, connector, doc area, or workflow.
|
|
2. Run the smallest tests that cover the changed surface.
|
|
3. Run broader checks when changing shared exports, setup state, or generated files.
|
|
4. Update `docs-site/content/docs/` when user-visible setup, CLI, configuration, or integration behavior changes.
|
|
5. Do not commit local secrets, generated build output, virtualenvs, dependency directories, or local databases.
|
|
|
|
For complete contributor setup and verification commands, read
|
|
[Contributing](/docs/community/contributing).
|