为 NcatBot 贡献代码的指引

---

Quick Reference

5 步完成你的第一次贡献：

1. Fork & Clone

git clone https://github.com/<your-username>/NcatBot.git
cd NcatBot

2. 安装开发环境

uv sync
.venv\Scripts\activate.ps1   # Windows
# source .venv/bin/activate  # Linux/macOS

3. 创建分支

git checkout -b feat/my-feature

4. 开发 & 测试

# 运行测试
python -m pytest tests/

# 代码格式化
ruff format .
ruff check . --fix

5. 提交 PR

git add .
git commit -m "feat: 描述你的修改"
git push origin feat/my-feature

然后在 GitHub 上创建 Pull Request。

---

本目录索引

目录	说明
development_setup/	开发环境搭建、工具链、常用命令
design_decisions/	架构决策记录（ADR）
module_internals/	模块内部实现详解

---

贡献规范

• 分支命名：feat/xxx、fix/xxx、docs/xxx
• Commit 格式：遵循 Conventional Commits
• 代码风格：使用 ruff 格式化，CI 会自动检查
• 测试：新功能需附带测试（项目正在重构中，测试暂不强制）

---

交叉引用

如果你在找…	去这里
架构总览	architecture.md
插件开发教程	guide/plugin/
API 参考	reference/

版权所有

版权归属：huan-yp

许可证：署名 4.0 国际 (CC-BY-4.0)