tw-eval-analyzer / CONTRIBUTING.md
lianghsun's picture
docs: add project README and MIT license section
740e5d3
# CONTRIBUTING
感謝你願意貢獻本專案!
## 基本流程
1. Fork 專案並建立分支(例:`feat/add-lesson-xyz`)。
2.`courses/` 下建立新課程資料夾(格式:`YYYY-MM-course-slug/`)。
3. 課程至少包含一個 `README.md` 與一組 `.ipynb`(notebook-first,完整可執行)。
4. 確認 notebook 能在 **Google Colab** 從零執行完成。
5. 發送 Pull Request,簡述修改重點與測試方式。
## 注意事項
- 優先確保 Notebook 內教學步驟完整,避免把程式抽到外部模組。
- 資料需避免個資與敏感資訊。
- 推薦在 PR 中附上 Colab 測試連結。