docs: Update README and add .DS_Store file.
This commit is contained in:
parent
f78a9adea7
commit
24a3ff28e1
69
README.md
69
README.md
@ -654,44 +654,71 @@ AI 不是神,它需要知道你的代码、你的报错、你的意图。
|
||||
|
||||
## 📦 提交要求
|
||||
|
||||
### 1. 提交材料
|
||||
1. **源代码**:完整项目文件夹。
|
||||
2. **README.md**:项目说明文档。
|
||||
3. **依赖文件**:包含 `pyproject.toml` 和 `uv.lock` (确保别人可以用 `uv sync` 还原你的环境)。
|
||||
4. **开发心得**:Markdown 格式,**不少于 500 字**。
|
||||
### 1. Git 提交指南 (必做)
|
||||
本课程通过校内 Git 平台提交作业。请组长负责统一提交。
|
||||
|
||||
### 2. README.md 模板
|
||||
#### Step 1: 注册与建仓
|
||||
1. **访问平台**: [HBLU Git](http://hblu.top:3000/Python2025-CourseDesign) (校内自建 Gitea)。
|
||||
2. **注册账号**: 组长注册一个账号。
|
||||
3. **创建仓库**: 在 `Python2025-CourseDesign` 组织下新建仓库。
|
||||
- 命名格式建议: `GroupXX-ProjectName` (如 `Group01-AIWriter`)。
|
||||
|
||||
#### Step 2: 规范化提交
|
||||
请确保你的项目符合以下 Git 规范:
|
||||
|
||||
1. **添加 `.gitignore` (至关重要)**
|
||||
> ⚠️ **严禁上传**: `.env` (包含 API Key) 和 `.venv` (包含几千个依赖文件)。
|
||||
|
||||
在项目根目录新建 `.gitignore` 文件,填入以下内容:
|
||||
```bash
|
||||
.env
|
||||
.venv/
|
||||
__pycache__/
|
||||
.DS_Store
|
||||
```
|
||||
|
||||
2. **推送代码**
|
||||
```bash
|
||||
git init
|
||||
git add .
|
||||
git commit -m "Complete Course Design Project"
|
||||
# 将下面的 URL 换成你刚才创建的仓库地址
|
||||
git remote add origin http://hblu.top:3000/Python2025-CourseDesign/Your-Repo-Name.git
|
||||
git push -u origin main
|
||||
```
|
||||
|
||||
### 2. 这里的 README.md 怎么写?
|
||||
你的仓库 `README.md` **必须**包含以下三个模块:
|
||||
|
||||
#### 2.1 团队成员与贡献 (必填)
|
||||
| 姓名 | 学号 | 主要贡献 (具体分工) |
|
||||
|:---:|:---:|:---|
|
||||
| 张三 | 2023xxx | (组长) 核心逻辑开发、Prompt 编写 |
|
||||
| 李四 | 2023xxx | 前端界面设计、PPT 制作 |
|
||||
| 王五 | 2023xxx | 文档撰写、测试与 Bug 修复 |
|
||||
|
||||
#### 2.2 项目简介 & 运行指南
|
||||
```markdown
|
||||
# [项目名称]
|
||||
|
||||
## 简介
|
||||
这句话介绍你的项目是做什么的,解决了什么问题。
|
||||
(一句话介绍:这个项目解决了什么痛点?)
|
||||
|
||||
## 如何运行
|
||||
1. 安装依赖:`uv sync`
|
||||
2. 配置 Key:复制 `.env.example` 为 `.env` 并填入 Key。
|
||||
3. 运行:`uv run streamlit run app.py`
|
||||
|
||||
## 功能列表
|
||||
- [x] 功能 A
|
||||
- [ ] 功能 B (待开发)
|
||||
2. 配置 Key:复制 `.env.example` 为 `.env` 并填入 Key
|
||||
3. 启动:`uv run streamlit run app.py`
|
||||
```
|
||||
|
||||
### 3. 📝 开发心得(必填,>500字)
|
||||
#### 2.3 开发心得 (不少于 500 字)
|
||||
> 请直接写在 README 的末尾,或单独创建一个 `REFLECTION.md`。
|
||||
|
||||
**请围绕以下核心问题撰写:**
|
||||
|
||||
1. **选题思考**:为什么做这个?解决了谁的痛苦?
|
||||
2. **AI 协作体验**:
|
||||
- 第一次用 AI 写代码的感觉?
|
||||
- 哪个 Prompt 让你直呼"牛逼"?哪个让你想砸键盘?
|
||||
- AI 生成的 Bug 你是怎么解的?
|
||||
3. **自我反思**:
|
||||
- 离开 AI,我还能写出这个吗?
|
||||
- AI 时代,我作为程序员的核心竞争力到底是什么?
|
||||
|
||||
> 💡 **真情实感最重要**。我们不想看套话,想看你的真实挣扎与顿悟。
|
||||
|
||||
---
|
||||
|
||||
## 🔗 附录:环境配置指南
|
||||
|
||||
Loading…
Reference in New Issue
Block a user