Security and project
Contributing
The steps to contribute a change, and where the full contributor guide and the release process live.
You will have a tested change on a branch, ready to open as a pull request. The contributor guide lives in the repository so it stays next to the code it describes: CONTRIBUTING.md.
Before you start
Contribute a change
- Install the dependencies:
just setup - Run a dev instance. It keeps its state in
.dev/and fakes the agents, so it never spends tokens and never touches~/.kraft:just dev
Open the Local URL it prints:http://localhost:5173, unless that port is taken. - Test your change and lint it:
just test just lint - Open a pull request. Give it exactly one
release::label, and write its user-facing line in the## Changelogsection of its description. Do not editCHANGELOG.md.
just test runs only the backend tests your changes affect. Do not call
pytest directly. When you change behavior, update the docs page that covers
it: CONTRIBUTING.md
has the table that says which. To find the module to change, see the
Source map. Maintainers cut releases as described in
RELEASING.md.
Next steps
- Source map: which module under
src/kraft/holds what, and where to change a given thing. - Architecture: how the parts fit together before you change one.