Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (65 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

80 lines (65 loc) · 3.89 KB
Raw

Contributing To Codegeist Agent Kit

This repository owns the generic OpenCode rules, commands, skills, helper scripts, plugins, and configuration shared by otherwise unrelated consuming repositories.

Shared Policies

The account-wide Codegeist policies apply alongside this repository-specific guide:

Do not report vulnerabilities or sensitive information in a public issue.

Choose The Owning Repository

Changes belong here only when they are useful across repositories with unrelated products, architectures, and deployment models. Project-specific paths, workflows, deployment behavior, and product conventions belong in the consuming repository's .oc_local/ commands, rules, or skills.

Open an issue before starting when ownership or generic applicability is unclear.

Source Workflow

  1. Check the Codegeist roadmap and any existing repository Issues.

  2. Use /task spec to create the canonical specification under docs/tasks/. Tasks default to Public Tracking: not requested. When public tracking is requested, the command confirms the repository's declared GitHub mirror, previews one concise Issue, creates it only after explicit user approval, and records its URL. Existing Issues may be reused. GitHub access requires GH_TOKEN; no browser login or stored GitHub CLI credential is used.

  3. An Issue labeled status:ready must link its canonical task. For a small unplanned fix, a maintainer may confirm that no new task is needed; state the reason in the pull request. Always use an existing task when one defines the work.

  4. Work on the current source branch. A topic branch based on source main is optional; agents create one only when the user explicitly requests it. Working directly on source main is supported.

  5. Use /task impl to implement the canonical task in source paths at the repository root. The generated release branch and consuming .opencode/ checkouts are distribution outputs, not implementation targets. The command must run the normal repository check before closing any linked Issue or recording solved:

    task test

    /task impl records a task with inactive public tracking as solved after that and any task-specific verification pass. For a linked task, it closes the validated Issue as completed and waits for GitHub to confirm the close before recording solved.

  6. Open a pull request that links the applicable local task and any linked Issue, summarizes the source and release impact, and reports verification. If no new task was required, state No local task needed: and the maintainer-approved reason.

task test copies and validates the release bundle without creating commits, publishing a release, or updating submodules. Release publication through task release-build is maintainer-only, happens after source review, and requires an explicit current user request authorizing its commit and push. Invoking the repository-local /release-build workflow supplies that authorization, including its documented subsequent /save workflow, without a second confirmation.

License

Codegeist-owned material and submitted contributions are accepted under the Zero-Clause BSD License, SPDX identifier 0BSD, without a separate CLA or DCO requirement. Preserve third-party licenses and notices.