Skip to content

Commit c8de8be

Browse files
committed
docs: 更新專案記憶和工作規範
- 記錄分支管理策略:gh-pages 為主,同步更新 main - 明確 Git commit 規範:不需添加作者資訊 - 新增文件撰寫規範:避免使用 emoji,保持簡潔專業
1 parent 9c06dd1 commit c8de8be

1 file changed

Lines changed: 36 additions & 6 deletions

File tree

CLAUDE.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -243,11 +243,34 @@ copilot-agent-demo-todo/
243243
- GitHub Pages 即時展示修改效果
244244
- 保留教學過程的完整記錄
245245

246-
### **Git Commit 作者規範**
246+
### **重要分支管理原則**
247+
#### **工作流程記憶事項**
248+
1. **主要在 gh-pages 分支工作**:所有修改都先在 gh-pages 進行
249+
2. **同步更新 main 分支**:重要更新必須同步到 main 分支
250+
3. **完成後切回 gh-pages**:推送完成後要切回 gh-pages 繼續工作
247251

248-
#### **重要:所有 commit 的作者必須是專案擁有者**
249-
- **Author**: Yulin Wang <yulin@example.com>
250-
- **純淨的 commit**:不添加額外的工具標註
252+
#### **執行順序**
253+
```bash
254+
# 1. 在 gh-pages 分支上工作和提交
255+
git add .
256+
git commit -m "描述"
257+
git push origin gh-pages
258+
259+
# 2. 合併到 main 分支
260+
git checkout main
261+
git merge gh-pages
262+
git push origin main
263+
264+
# 3. 切回 gh-pages 繼續工作
265+
git checkout gh-pages
266+
```
267+
268+
### **Git Commit 規範**
269+
270+
#### **重要:不需要在 commit message 中添加作者資訊**
271+
- Git 已經記錄了作者資訊,不需要重複
272+
- 不要使用 Co-Authored-By 或其他作者標註
273+
- 保持 commit message 簡潔專注於變更內容
251274

252275
#### **標準 Commit 格式**
253276
```bash
@@ -257,7 +280,7 @@ git commit -m "feat: 功能描述
257280
```
258281

259282
#### **為什麼這樣設計?**
260-
- **專案擁有權明確**Yulin Wang 是專案的唯一負責人和作者
283+
- **避免冗餘**Git 本身已有完整的作者記錄
261284
- **保持簡潔**:commit 訊息專注於變更內容本身
262285
- **專業呈現**:乾淨的 git 歷史記錄
263286

@@ -268,4 +291,11 @@ git commit -m "feat: 功能描述
268291
- 建立和管理指令檔案系統
269292
- 設計有效的 Prompt Files
270293
- 在實際專案中提升 30-50% 開發效率
271-
- 建立團隊級的 AI 輔助開發流程
294+
- 建立團隊級的 AI 輔助開發流程
295+
296+
## 文件撰寫規範
297+
298+
### **重要:保持簡潔專業的風格**
299+
- **避免使用 emoji**:除非使用者明確要求,否則不使用表情符號
300+
- **保持專業語調**:使用清晰、直接的文字表達
301+
- **簡潔為上**:避免不必要的裝飾性元素

0 commit comments

Comments
 (0)