Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (47 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 1.72 KB

🤝 Contributing Guide | 讀書會共筆參與方式

歡迎加入我們的 Python 讀書會共筆！

📌 貢獻方式（For Public Repo）

我們採用 GitHub 的 Fork → PR 流程，任何人都可以透過以下步驟參與：

  1. Fork 本 Repo 到你的 GitHub 帳號
  2. 在你的分支中建立或修改檔案
  3. 發送 Pull Request（PR）回本 Repo
  4. 管理員會 Review 並合併你的貢獻

🗂 檔案結構建議

python-study-group/
├── week_01_basics/
│   ├── notes.md          # 本週共筆筆記
│   └── exercises.md      # 練習題與範例
├── contributors/
│   ├── your_name_notes.md
│   └── your_name_week2.ipynb

每個人都可以在 contributors/ 中建立屬於自己的筆記或心得，命名格式不限，但請保持清楚。

✍️ 貢獻內容類型

你可以貢獻的內容包含（不限於）：

  • 課程章節摘要（Markdown 筆記）
  • 練習題解法（程式碼 or 說明）
  • 補充教材、延伸閱讀
  • 小專案 Demo、心得分享

🔧 格式與命名小建議

  • 語言：中英皆可，中英對照更佳
  • 檔案：使用 .md, .py, .ipynb 皆可
  • Commit message 清楚簡潔，例如： 
    Add week3 notes
Update exercise solutions
Fix typo in week1 summary

🙋 常見問題

Q: 我是新手不太會用 GitHub 怎麼辦？

A: 沒關係，可以先把筆記貼在 Google Docs 或 HackMD，我們幫你搬進來也沒問題！

Q: 我可以改別人的筆記嗎？

A: 可以，但請送 PR 並禮貌地在留言說明原因與修改內容 🙏

感謝你參與這份共筆，Python 學習的路上，有你一起就更好！💪
Let's learn Python together!