怎麼給開源項目提第一個 PR 提示詞(讀懂貢獻指南、挑 good first issue、寫 PR 描述)
想參與開源但不知道從哪裏下手,或者已經改好了代碼不知道怎麼提交時用:把項目的貢獻指南和你想做的問題給 AI,它幫你判斷問題是否適合新人、列出提交前的檢查項、起草問題評論和 PR 描述,提高被合併的概率。
通用大模型 對話模型通用
我想給一個開源項目提交第一個 Pull Request,請你作為有經驗的開源維護者指導我。 - 項目名稱與倉庫地址:[項目倉庫] - 項目的貢獻指南(CONTRIBUTING 文件或 README 中的相關部分,原文粘貼): [粘貼貢獻指南] - 我感興趣的問題(issue 標題、描述和討論): [粘貼 issue 內容] - 我的技術背景:[如熟悉 Python,第一次參與開源] - 當前進度:[還沒開始/已經改好代碼] 請按順序幫我: 1. 讀貢獻指南,提煉出我必須遵守的規則:是否需要先認領問題、分支命名、提交資訊格式、是否要求籤署貢獻者協議或在提交中添加簽名、代碼風格與檢查命令、測試要求、文檔要求。 2. 評估這個問題是否適合我:難度、需要了解的模組、是否已經有人在做(看討論裏的認領情況)、維護者是否認可這個方向。不適合時,告訴我怎麼找更合適的問題。 3. 如果需要先在問題下留言,幫我寫一段簡短、禮貌的英文留言,說明我打算怎麼做、並詢問維護者意見。 4. 給出從復刻倉庫到提交的操作步驟,包括與上游保持同步的方法。 5. 提交前檢查清單:只改與問題相關的內容(不順手格式化無關文件)、通過項目的檢查和測試、補充或更新測試、更新文檔或變更記錄(如果項目要求)。 6. 起草 PR 標題和描述(英文,附中文翻譯):關聯的問題編號、改了什麼、為什麼這樣改、如何驗證、需要維護者特別關注的地方。 7. 收到評審意見後怎麼回應和更新,以及長時間沒人回覆時如何禮貌地提醒。 貢獻指南里沒有提到的規則,不要編造,標註「貢獻指南未說明,可參考同倉庫最近被合併的 PR」。
高亮處換成你自己的內容:[項目倉庫]、[粘貼貢獻指南]、[粘貼 issue 內容]、[如熟悉 Python,第一次參與開源]、[還沒開始/已經改好代碼]
ChatGPT Plus 充值
已被複製 0 次
使用說明
怎麼填變量:[粘貼貢獻指南] 是最重要的輸入,每個項目的規則差別很大:有的要求先討論再寫代碼,有的要求每次提交都帶簽名,有的要求更新變更記錄。把原文完整貼進去,避免 AI 按「一般慣例」猜。
常見坑:
- 沒看清討論就直接動手,結果別人已經在做,或者維護者早就說過不打算這樣改。先在問題下留言確認方向。
- PR 裏夾帶大量無關修改(編輯器自動格式化了整個文件),維護者很難評審,往往直接被要求拆分。
- PR 描述只寫「fix bug」。寫清楚改了什麼、為什麼、怎麼驗證,能顯著縮短評審時間。
追問技巧:收到評審意見後,把意見原文和你的修改貼回來,問「我的修改是否回應了每一條意見,回覆怎麼寫比較得體」。
示例輸出
示例,僅供參考(PR 描述節選)
markdown
## Fix incorrect timezone in exported CSV timestamps
Closes #1234
### What
Export now converts timestamps to the user's configured timezone instead of UTC.
### Why
Users reported that exported times were off by several hours (see discussion in #1234).
### How to test
1. Set timezone to Asia/Shanghai in settings
2. Export any report
3. Timestamps should match the values shown in the UI
Added a unit test in `tests/test_export.py` covering non-UTC timezones.
中文:修復導出 CSV 時間戳時區錯誤。導出時改為按用戶設定的時區轉換,並新增了非 UTC 時區的單元測試。
同款作品
用這條提示詞做出來的作品;原作者會因此獲得積分
還沒有同款,來做第一個。



0 條評論
還沒有評論,來搶沙發~