From a56d6af2db6f982713091efeebe7c8351a9d998b Mon Sep 17 00:00:00 2001 From: Bo Date: Thu, 19 Feb 2026 15:10:00 +0800 Subject: [PATCH 1/7] docs: add contributing guide --- docs/CONTRIBUTE.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 docs/CONTRIBUTE.md diff --git a/docs/CONTRIBUTE.md b/docs/CONTRIBUTE.md new file mode 100644 index 0000000..d7c6a46 --- /dev/null +++ b/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 + +> **外设** +> 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. From 2d48c1272af5986c24059a1c276d5a1b18e97e03 Mon Sep 17 00:00:00 2001 From: Bo Date: Thu, 19 Feb 2026 16:20:00 +0800 Subject: [PATCH 2/7] docs: add changelog --- docs/CHANGELOG.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/CHANGELOG.md diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 0000000..c479b2f --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. + +## Unreleased + +### Added + +- Contribution guidelines and changelog documentation. From 2cba142fd100be4dac93781a9f2714a8e820e6e7 Mon Sep 17 00:00:00 2001 From: Bo Date: Thu, 19 Feb 2026 18:00:00 +0800 Subject: [PATCH 3/7] docs: update readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index cead192..747ed34 100644 --- a/README.md +++ b/README.md @@ -190,6 +190,14 @@ 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. + +## Changelog + +See **[docs/CHANGELOG.md](docs/CHANGELOG.md)** for release notes and notable changes. + ## License MIT From 09422a3a6c9d0b4f2a13cf1ff7493a509d27f5e9 Mon Sep 17 00:00:00 2001 From: Bo Date: Thu, 19 Feb 2026 20:15:00 +0800 Subject: [PATCH 4/7] docs: update readme cn --- README_CN.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README_CN.md b/README_CN.md index 93def4e..055d0db 100644 --- a/README_CN.md +++ b/README_CN.md @@ -205,6 +205,14 @@ MimiClaw 内置 cron 调度器，让 AI 可以自主安排任务。LLM 可以通 - **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** — 系统设计、模块划分、任务布局、内存分配、协议、Flash 分区 - **[docs/TODO.md](docs/TODO.md)** — 功能差距和路线图 +## 贡献 + +提交 Issue 或 PR 前请先阅读 **[docs/CONTRIBUTE.md](docs/CONTRIBUTE.md)**。 + +## 变更日志 + +发布记录与重要变更见 **[docs/CHANGELOG.md](docs/CHANGELOG.md)**。 + ## 许可证 MIT From ef8b4028f9f248500e4cbb39e2bf7adc2d0a9e85 Mon Sep 17 00:00:00 2001 From: Bo Date: Thu, 19 Feb 2026 22:30:00 +0800 Subject: [PATCH 5/7] docs: update readme ja --- README_JA.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README_JA.md b/README_JA.md index 8ffc09f..5d4d2ea 100644 --- a/README_JA.md +++ b/README_JA.md @@ -190,6 +190,14 @@ MimiClawにはcronスケジューラが内蔵されており、AIが自律的に - **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** — システム設計、モジュール構成、タスクレイアウト、メモリバジェット、プロトコル、Flashパーティション - **[docs/TODO.md](docs/TODO.md)** — 機能ギャップとロードマップ +## コントリビュート + +Issue や PR の前に **[docs/CONTRIBUTE.md](docs/CONTRIBUTE.md)** を確認してください。 + +## 変更履歴 + +リリースノートと主な変更点は **[docs/CHANGELOG.md](docs/CHANGELOG.md)** を参照してください。 + ## ライセンス MIT From c3e951afb0c08afde834666bad65af86ea40d5c1 Mon Sep 17 00:00:00 2001 From: Bo Date: Thu, 19 Feb 2026 20:55:23 +0800 Subject: [PATCH 6/7] docs: update contributing guide --- docs/CONTRIBUTE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTE.md b/docs/CONTRIBUTE.md index d7c6a46..943f3e2 100644 --- a/docs/CONTRIBUTE.md +++ b/docs/CONTRIBUTE.md @@ -11,7 +11,7 @@ We accept contributions in these areas: - 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 From 7f8a7caa00d221c7c82de9e2c14703e95a2b7f66 Mon Sep 17 00:00:00 2001 From: Bo Date: Thu, 19 Feb 2026 20:55:30 +0800 Subject: [PATCH 7/7] docs: remove changelog --- README.md | 4 ---- README_CN.md | 8 ++------ README_JA.md | 8 ++------ docs/CHANGELOG.md | 11 ----------- 4 files changed, 4 insertions(+), 27 deletions(-) delete mode 100644 docs/CHANGELOG.md diff --git a/README.md b/README.md index 747ed34..18e81df 100644 --- a/README.md +++ b/README.md @@ -194,10 +194,6 @@ Technical details live in the `docs/` folder: Please read **[docs/CONTRIBUTE.md](docs/CONTRIBUTE.md)** before opening issues or pull requests. -## Changelog - -See **[docs/CHANGELOG.md](docs/CHANGELOG.md)** for release notes and notable changes. - ## License MIT diff --git a/README_CN.md b/README_CN.md index 055d0db..8c2d1e5 100644 --- a/README_CN.md +++ b/README_CN.md @@ -205,13 +205,9 @@ MimiClaw 内置 cron 调度器，让 AI 可以自主安排任务。LLM 可以通 - **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** — 系统设计、模块划分、任务布局、内存分配、协议、Flash 分区 - **[docs/TODO.md](docs/TODO.md)** — 功能差距和路线图 -## 贡献 +## Contributing -提交 Issue 或 PR 前请先阅读 **[docs/CONTRIBUTE.md](docs/CONTRIBUTE.md)**。 - -## 变更日志 - -发布记录与重要变更见 **[docs/CHANGELOG.md](docs/CHANGELOG.md)**。 +Please read **[docs/CONTRIBUTE.md](docs/CONTRIBUTE.md)** before opening issues or pull requests. ## 许可证 diff --git a/README_JA.md b/README_JA.md index 5d4d2ea..82c4bfb 100644 --- a/README_JA.md +++ b/README_JA.md @@ -190,13 +190,9 @@ MimiClawにはcronスケジューラが内蔵されており、AIが自律的に - **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** — システム設計、モジュール構成、タスクレイアウト、メモリバジェット、プロトコル、Flashパーティション - **[docs/TODO.md](docs/TODO.md)** — 機能ギャップとロードマップ -## コントリビュート +## Contributing -Issue や PR の前に **[docs/CONTRIBUTE.md](docs/CONTRIBUTE.md)** を確認してください。 - -## 変更履歴 - -リリースノートと主な変更点は **[docs/CHANGELOG.md](docs/CHANGELOG.md)** を参照してください。 +Please read **[docs/CONTRIBUTE.md](docs/CONTRIBUTE.md)** before opening issues or pull requests. ## ライセンス diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md deleted file mode 100644 index c479b2f..0000000 --- a/docs/CHANGELOG.md +++ /dev/null @@ -1,11 +0,0 @@ -# Changelog - -All notable changes to this project will be documented in this file. - -The format is based on Keep a Changelog, and this project adheres to Semantic Versioning. - -## Unreleased - -### Added - -- Contribution guidelines and changelog documentation.