> For the complete documentation index, see [llms.txt](https://docs.zenml.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zenml.io/kitaru/get-help/contributing.md).

# Contributing

How to contribute to Kitaru.

We welcome contributions to Kitaru! For full guidelines, see [CONTRIBUTING.md](https://github.com/zenml-io/kitaru/blob/develop/CONTRIBUTING.md) in the repository.

## Quick Start

```bash
git clone https://github.com/zenml-io/kitaru.git
cd kitaru
uv sync
just check   # Run all checks
just test    # Run tests
```

## Key Details

* **Default branch:** `develop`; all PRs target this branch
* **Checks:** `just check` runs formatting, linting, type checking, typos, and YAML validation
* **Docs:** These pages live in `docs/book/` (GitBook source, plain Markdown). Edit the `.md` files and register new pages in `docs/book/toc.md`
* **Outside contributors:** Direct PRs are limited to collaborators. Comment on an existing issue or open a new one before you write code; once a maintainer agrees on the approach, they will add you as a collaborator so you can open the PR. Small fixes like typos: just open an issue and we'll make the change.

## Links

* [GitHub Repository](https://github.com/zenml-io/kitaru)
* [Issue Tracker](https://github.com/zenml-io/kitaru/issues)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zenml.io/kitaru/get-help/contributing.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.