Merge pull request #66 from IRONICBo/docs/add-contribute-guide

README.md

@@ -190,6 +190,10 @@ Technical details live in the `docs/` folder:
 - **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** — system design, module map, task layout, memory budget, protocols, flash partitions
 - **[docs/TODO.md](docs/TODO.md)** — feature gap tracker and roadmap
 
+## Contributing
+
+Please read **[docs/CONTRIBUTE.md](docs/CONTRIBUTE.md)** before opening issues or pull requests.
+
 ## License
 
 MIT

README_CN.md

@@ -205,6 +205,10 @@ MimiClaw 内置 cron 调度器，让 AI 可以自主安排任务。LLM 可以通
 - **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** — 系统设计、模块划分、任务布局、内存分配、协议、Flash 分区
 - **[docs/TODO.md](docs/TODO.md)** — 功能差距和路线图
 
+## Contributing
+
+Please read **[docs/CONTRIBUTE.md](docs/CONTRIBUTE.md)** before opening issues or pull requests.
+
 ## 许可证
 
 MIT

README_JA.md

@@ -190,6 +190,10 @@ MimiClawにはcronスケジューラが内蔵されており、AIが自律的に
 - **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** — システム設計、モジュール構成、タスクレイアウト、メモリバジェット、プロトコル、Flashパーティション
 - **[docs/TODO.md](docs/TODO.md)** — 機能ギャップとロードマップ
 
+## Contributing
+
+Please read **[docs/CONTRIBUTE.md](docs/CONTRIBUTE.md)** before opening issues or pull requests.
+
 ## ライセンス
 
 MIT

docs/CONTRIBUTE.md

@@ -0,0 +1,59 @@
+# Contributing
+
+Thanks for your interest in MimiClaw. This project welcomes focused, high-quality contributions that improve reliability, performance, or documentation.
+
+## Scope
+
+We accept contributions in these areas:
+
+- Core firmware features and bug fixes
+- Documentation, examples, and diagrams
+- Build and tooling improvements
+- Tests and CI enhancements
+
+> **External Peripherals**
+> We are not accepting PRs that add or change external peripherals right now.
+
+## Before You Start
+
+- Search existing issues and discussions to avoid duplication.
+- Open a short proposal for large or risky changes.
+- Keep changes small and reviewable when possible.
+
+## Development Setup
+
+- Install ESP-IDF v5.5+.
+- Build targets are in `idf.py`.
+- Default config lives in `main/mimi_secrets.h.example`.
+
+## Branching and Commits
+
+- Use a short, descriptive branch name.
+- Keep commit history clean and focused.
+- Suggested commit style: `docs: ...`, `fix: ...`, `feat: ...`.
+
+## Pull Requests
+
+- Describe the problem and the solution clearly.
+- Include testing steps and results.
+- Update documentation when behavior changes.
+
+## Code Style
+
+- Match existing naming and formatting.
+- Prefer clarity over cleverness.
+- Avoid large refactors mixed with functional changes.
+
+## Tests
+
+- Add or update tests when behavior changes.
+- If tests are not available, explain why and how you validated the change.
+
+## Documentation
+
+- Keep README and docs in sync with behavior changes.
+- Add concise examples for new features.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.