Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (54 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

81 lines (54 loc) · 2.33 KB
Raw

Contributing to miniClaw

Thanks for helping improve miniClaw.

Quick Links

Before You Start

  • Keep changes focused. One pull request should solve one problem.
  • Prefer small, reviewable diffs over broad refactors.
  • Preserve the teaching value of the public source and workspace templates. Readability matters as much as correctness.

Development Setup

git clone <your-repo-url>
cd miniClaw

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

cp .env.example .env
# Edit .env with your Anthropic API key if you plan to run API-backed examples

Verification

Run the repository checks before opening a pull request:

python3 scripts/repo_health_check.py

Bilingual Synchronization

miniClaw maintains English and Chinese public documentation in parallel.

  • Documentation updates should keep README.md and README.zh.md aligned
  • Shared workspace guidance should stay semantically consistent across languages when both versions exist

Pull Request Guidelines

  • Explain the problem and the chosen fix clearly
  • Include the verification commands you ran
  • Update the changelog if the change affects users, contributors, or repository workflow
  • Do not include secrets, personal data, or unrelated formatting churn

Commit Style

Conventional, readable commit prefixes are preferred:

  • feat: new lesson content or user-facing functionality
  • fix: bug fixes or correctness changes
  • docs: documentation-only changes
  • chore: maintenance, templates, automation, or cleanup

Style Expectations

  • Follow PEP 8 for Python
  • Use descriptive names and simple control flow
  • Favor small functions and direct examples over clever abstractions
  • Add comments only where the teaching intent would otherwise be unclear

Maintainer Release Checklist

Before tagging a release:

  1. Update CHANGELOG.md
  2. Run python3 scripts/repo_health_check.py
  3. Review the public documentation and workspace templates for consistency
  4. Confirm root documentation and community files are current

Questions

Open an issue for public questions, or contact the maintainer at 543370794@qq.com when a private conversation is necessary.