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 covers the development setup, make targets, how to add a channel or a provider, and the pull request checklist.
Codebase map what each package does, where to start reading, and how a message travels.Brand the logo files, the colours and what the mark means.Roadmap release phases and known gaps.
Writing docs#
The docs live in docs/, one folder per section, and are published at 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.
In this section
- Codebase mapA map of cmd/ and internal/: what each package does, where to start reading, and how a message travels from a chat to the model and back.
- BrandHow to use the Habakkuk logo files, the colours (ink, cream and gold), and what the mark means.
- RoadmapRelease phases, what each one ships, and known gaps.