Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 2.33 KB

File metadata and controls

53 lines (41 loc) · 2.33 KB

Contributing to Brokk Town

Contributions from people using AI tools are welcome. Everyone remains responsible for the accuracy, safety, licensing, and relevance of their work. Please follow the Code of Conduct.

Issues and pull requests

Search existing issues and pull requests before opening a new one. For bugs, include the version or commit, operating system, reproduction steps, expected behavior, and actual behavior. Redact secrets and private source code from logs and transcripts. Report vulnerabilities privately as described in SECURITY.md.

Keep changes focused. Discuss substantial behavior or interface changes with maintainers before implementing them. A pull request should explain the problem, resulting behavior, validation performed, and any remaining limits. Link related issues and update documentation when behavior changes.

Development and validation

Install the Go version in go.mod, Node.js 24+, and Python 3. Run from the repository root:

npm run check
npm test
go test -race ./...
go vet ./...
python3 scripts/licenses.py
python3 -m unittest discover -s scripts -p '*_test.py'

Format Go changes with gofmt. Add focused tests for behavior changes; ordinary documentation changes need a diff and link review. Tests should use temporary repositories and simulated agents, without publishing releases or requiring live credentials.

Run make build and check bin/bt serve --demo and bin/bt tui --demo when changing the local service or clients. Never run live autonomous bots as a development test. For installer and release changes, run make package-smoke from a clean committed checkout. See RELEASING.md for the publishing pipeline.

Licensing and dependencies

This project uses Apache-2.0. By intentionally submitting a contribution for inclusion, you submit it under the project's license unless you explicitly state otherwise, as described in section 5. Submit only work you have the right to share and preserve upstream attribution and notices.

Dependency versions, legal texts, generated tables, and bundled assets require license review. Follow licenses/README.md, update the reviewed policy and notices together, and commit go.mod and go.sum when dependencies change. Do not add local replacement directives to a release.