💖 AI深夜奶茶店 Wiki 貢獻者指南¶
非常感謝您願意花時間,為我們的社群知識庫貢獻一份心力!您的每一次分享,都會讓這個 Wiki 變得更棒。
本指南旨在幫助任何人,即使您完全不懂程式或 Git,也能輕鬆地透過網頁來新增或修改 Wiki 內容。
✨ 貢獻的核心精神¶
- 友善分享:保持內容的友善、清晰與客觀。
- 樂於助人:我們撰寫內容的目的是為了幫助社群中的每一個人。
- 持續迭代:別擔心不完美,任何貢獻都是一個好的開始,我們可以一起讓它變得更好。
🚀 如何開始貢獻?¶
我們將所有操作都設計在 GitHub 網頁上,您完全不需要接觸複雜的指令!
方式一:修改現有頁面 (最簡單!)¶
當您發現某篇文章有錯字、可以補充更多內容或更新資訊時,這是最簡單的貢獻方式。
- 在 Wiki 網站上,找到您想修改的頁面。
- 點擊頁面標題右上角的鉛筆圖示 ✏️ (Edit this page)。
- GitHub 會自動帶您到該檔案的網頁編輯介面。
- 直接在編輯器中修改內容。
- 完成後,捲到頁面最下方,在一個標題為 "Propose changes" 的區塊中:
- 在第一個輸入框中,簡單描述您的修改,例如:「修正錯字:將 LLM 寫成 LMM」。
- 點擊綠色的 "Propose changes" 按鈕。
恭喜!您已經成功送出了一份修改提案!
方式二:使用範本新增頁面¶
當您想分享一篇新的教學或資源時,請使用我們預設好的範本,以確保格式統一。
-
複製範本內容:
- 前往專案的 templates 資料夾。
- 根據您想新增的內容類型,點開對應的範本檔案(例如
tutorial-template.md)。 - 點擊右上角的「複製原始檔案內容」按鈕(兩個方塊疊在一起的圖示)。
-
建立新檔案:
- 導覽到您想放置新頁面的資料夾,例如
docs/tutorials/rp/。 - 點擊右上角的「Add file」按鈕,選擇「Create new file」。
- 導覽到您想放置新頁面的資料夾,例如
-
貼上與撰寫:
- 在最上方的檔名輸入框中,為您的文章取一個有意義的英文檔名,並以
.md結尾,例如my-new-tutorial.md。 - 將剛剛複製的範本內容,完整貼到下方的編輯區。
- 依照範本內的註解提示,專心撰寫您的內容。
- 在最上方的檔名輸入框中,為您的文章取一個有意義的英文檔名,並以
-
提交您的創作:
- 完成後,捲到頁面最下方 "Commit new file" 的區塊。
- 在第一個輸入框中,簡單描述您新增的文章,例如:「新增:一篇關於...的教學」。
- 【關鍵一步】 請務必選擇下方的選項:「Create a new branch for this commit and start a pull request.」
- 點擊綠色的 "Propose new file" 按鈕。
方式三:新增圖片¶
如果您的文章需要附上圖片,請依照以下流程:
-
上傳圖片:
- 前往專案的 assets/images 資料夾。
- 點擊「Add file」->「Upload files」。
- 將您的圖片拖曳上傳。請確保圖片檔名是小寫英文,例如
prompt-example-1.png。 - 直接提交上傳 (Commit changes)。
-
在文章中引用圖片:
- 回到您正在編輯的文章
.md檔案。 - 在您想插入圖片的地方,使用以下格式:
 - 請注意
../的使用,它代表「回到上一層資料夾」。您需要根據文章的位置來調整路徑。
- 回到您正在編輯的文章
📝 關於 Pull Request (PR) 的流程¶
當您依照上述方式提交修改或新增頁面後,系統會自動建立一個 Pull Request (PR)。
您可以把 PR 想像成一份「修改提案」。專案的維護者會收到通知,並來審閱您的貢獻。
- 討論與修改:維護者可能會在 PR 中留言,與您討論內容或請求一些小修改。
- 合併:一旦您的貢獻被審核通過,維護者就會將其「合併 (Merge)」,您所做的變更就會在幾分鐘後自動出現在正式的 Wiki 網站上!