Contributing
Contributing#
Nixi is free and open source under AGPL-3.0. Contributions are welcome.
Development Setup#
git clone https://codeberg.org/ewrogers/nixi.git
cd nixi
go build ./cmd/nixi
go vet ./...
With Nix:
nix develop # drops you into a shell with Go, gopls, delve
nix build # builds the nixi binary
Code Style#
- Run
gofmtbefore committing (enforced) - Use conventional commits (
feat:,fix:,docs:,refactor:,chore:) - Write in a natural, human tone – no em dashes
- Keep documentation in sync when changing code
Adding a Tool#
- Create a new file in
internal/tools/implementing theToolinterface - Use the
Executorinterface for all command execution - Register it in
internal/agent/agent.go - Add documentation in
docs/content/tools.md
Project Structure#
The TUI and Web UI must maintain feature parity. Any feature added to one should be added to the other.
Reporting Issues#
File issues on Codeberg.