From bf6bf199797cfbd6ff6f2d09243666ca5eeb31fd Mon Sep 17 00:00:00 2001
From: Acbox <acbox0328@gmail.com>
Date: Thu, 29 Jan 2026 22:29:51 +0800
Subject: [PATCH] docs: add CONTRIBUTING

---
 CONTRIBUTING.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       |  7 +----
 2 files changed, 72 insertions(+), 6 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..d3371d3d
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,71 @@
+# Contributing Guide
+
+## Mise
+
+You need to install mise first.
+
+### Linux/macOS
+
+```bash
+curl https://mise.run | sh
+```
+
+Or use homebrew:
+
+```bash
+brew install mise
+```
+
+### Windows
+
+```bash
+winget install jdx.mise
+```
+
+## Initialize
+
+Install toolchains and dependencies:
+
+```bash
+mise install
+```
+
+Setup project:
+
+```bash
+mise run setup
+```
+
+## Configure
+
+Copy config.toml.example to config.toml and configure:
+
+```bash
+cp config.toml.example config.toml
+```
+
+## Development
+
+Start development environment:
+
+```bash
+mise run dev
+```
+
+## More Commands
+
+| Command | Description |
+| ------- | ----------- |
+| `mise run dev` | Start development environment |
+| `mise run setup` | Setup development environment |
+| `mise run db-up` | Intialize and Migrate Database |
+| `mise run db-down` | Drop Database |
+| `mise run swagger-generate` | Generate Swagger documentation |
+| `mise run sqlc-generate` | Generate SQL code |
+| `mise run pnpm-install` | Install dependencies |
+| `mise run go-install` | Install Go dependencies |
+| `mise run //agent:dev` | Start agent gateway development server |
+| `mise run //cmd/agent:start` | Start main server |
+| `mise run //packages/web:dev` | Start web development server |
+| `mise run //packages/web:build` | Build web |
+| `mise run //packages/web:start` | Start web preview |
\ No newline at end of file
diff --git a/README.md b/README.md
index 10b4032a..b49ee525 100644
--- a/README.md
+++ b/README.md
@@ -26,12 +26,7 @@ Memoh是一个专属于你的AI私人管家，你可以把它跑在你的NAS，
 
 ## Development
 
-你需要先安装mise，然后执行以下命令：
-
-```bash
-mise install
-mise run dev
-```
+Refer to [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
 
 ## Star History