Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (55 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

80 lines (55 loc) · 2.16 KB
Raw

Contributing to DockerClaw

Thank you for considering a contribution.

DockerClaw is being built as the OS-level harness framework for OpenClaw. The most valuable early contributions are not only bug fixes, but also clear modules, validators, target-aware improvements, and documentation that makes the system easier to understand and extend.

What We Need Most

  • new modules
  • validator improvements
  • target-aware build/runtime resolution
  • better generated build and compose outputs
  • documentation improvements
  • examples that clarify the framework model

Before You Start

Read these first:

  • README.md
  • dockerclaw-framework.md
  • dev-rules/module-development.md
  • modules/template-module/

Contribution Principles

  • keep the framework explicit and composable
  • prefer declarative module behavior over hidden script logic
  • keep platform assumptions visible
  • keep public docs focused on the framework, not local machine state
  • avoid introducing silent fallbacks for materially different behaviors

Module Contributions

If you are creating or changing a module:

  1. Follow the module contract:
    • module.json
    • resources.json
    • runtime.json
    • instructions.md
  2. Keep platform compatibility explicit.
  3. Declare resource ownership clearly.
  4. Keep bootstrap behavior idempotent.
  5. Add or update implementation notes in instructions.md.

Validation

Run these before opening a PR:

python3 scripts/validate-modules.py

If your change affects an agent lock or generated artifacts, also run:

python3 scripts/validate-agent.py <agent-name|path-to-modules.lock.json>

Pull Requests

Please keep pull requests focused.

  • one architectural concern per PR when possible
  • explain why the change matters
  • call out platform assumptions
  • mention any new module, target, or generated artifact introduced

Early Project Status

DockerClaw is still in an early public stage.

That means:

  • architecture clarity matters more than feature count
  • generated workflows are still evolving
  • breaking internal structure changes may still happen while the framework hardens

If you want to contribute a module, this is a very good time to do it.