Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (28 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.27 KB
Raw

Contributing

Thanks for helping improve Cooperations.

Prerequisites

  • Go 1.24+
  • Linux with bash
  • codex CLI installed for real workflow execution

status, history, and run --dry-run do not require Codex CLI initialization. Real workflow runs do. The real Gio GUI build is opt-in via go build -tags gio.

Setup

cp .env.example .env
go test ./...

Development Guidelines

  • Keep the implemented runtime truthful and local-first.
  • Keep the runtime Codex CLI-first; do not add OpenAI API provider wiring casually.
  • Preserve the fail-closed task contract for sandbox and capability validation.
  • Preserve the split between implemented core and experimental/reference material.
  • Prefer simple, readable Go code over speculative abstractions.
  • Add tests for bug fixes and non-trivial behavior changes.
  • Avoid committing secrets, local task history, or generated artifacts.
  • If a docs change affects current behavior, update README.md and docs/STATUS.md in the same change.

Pull Requests

  1. Keep the change set focused.
  2. Ensure the relevant tests pass.
  3. Describe the problem, approach, and any runtime or docs truth changes.

License

By contributing, you agree that your contributions are licensed under the GNU Affero General Public License v3.0.