# Contributing

> Work on Habakkuk itself: the codebase map, the brand rules, the roadmap, and the contributing guide.


Habakkuk is one Go module, `github.com/habakkuk-ai/habakkuk`, under the Apache License 2.0. The repository's [contributing guide](https://github.com/habakkuk-ai/habakkuk/blob/main/CONTRIBUTING.md) covers the development setup, `make` targets, how to add a channel or a provider, and the pull request checklist.

<!-- cards -->
- [Codebase map](https://www.habakkuk.ai/docs/contributing/codebase.md): what each package does, where to start reading, and how a message travels.
- [Brand](https://www.habakkuk.ai/docs/contributing/brand.md): the logo files, the colours and what the mark means.
- [Roadmap](https://www.habakkuk.ai/docs/contributing/roadmap.md): release phases and known gaps.

## Writing docs

The docs live in `docs/`, one folder per section, and are published at [habakkuk.ai/docs](https://habakkuk.ai/docs). Describe what the code does today, and check the code when unsure. CONTRIBUTING.md lists the page conventions: frontmatter, callouts, tabs and card lists.

---

Source: https://www.habakkuk.ai/docs/contributing