Polish project documentation and runtime config
This commit is contained in:
48
CONTRIBUTING.md
Normal file
48
CONTRIBUTING.md
Normal file
@@ -0,0 +1,48 @@
|
||||
# 贡献指南
|
||||
|
||||
欢迎基于本项目继续扩展旅行知识图谱能力。提交前请先确保本地可以构建和启动。
|
||||
|
||||
## 开发环境
|
||||
|
||||
后端:
|
||||
|
||||
```bash
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
cp .env.example .env
|
||||
python -m uvicorn app.main:app --host 0.0.0.0 --port 8102 --reload
|
||||
```
|
||||
|
||||
前端:
|
||||
|
||||
```bash
|
||||
cd admin-web
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Docker:
|
||||
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
## 提交规范
|
||||
|
||||
- 保持改动聚焦,一次提交解决一个明确问题。
|
||||
- 不提交 `.env`、密钥、浏览器缓存、日志、数据卷和 `node_modules/`。
|
||||
- 如果修改 API,同步更新 `docs/API_REFERENCE.md`。
|
||||
- 如果修改部署配置,同步更新 `README.md` 和 `docs/DEPLOYMENT.md`。
|
||||
- 如果修改快照,同步更新 `docs/DATA_SNAPSHOTS.md` 中的数量和哈希。
|
||||
|
||||
## 建议检查
|
||||
|
||||
```bash
|
||||
python -m compileall app
|
||||
cd admin-web && npm run build
|
||||
cd ..
|
||||
docker compose config
|
||||
```
|
||||
|
||||
涉及 Docker、快照或登录逻辑的修改,需要额外执行完整 compose 启动验证。
|
||||
Reference in New Issue
Block a user