跳轉到

提供拉取請求審查

歡迎大家檢閱任何對BeeWare專案的貢獻。在開始之前,有一些重要的注意事項。

審閱前請先思考

在進行評論之前,請先思考。身為評審員,我們應該考慮我們即將發出的回應是否是:

  • 真實。始終努力提供準確的建議和資訊。
  • 有幫助。我們會就如何改善提交內容提供指導;此指導應明確指出問題的來源或未考慮的使用個案,並最好提供解決或滿足疑慮的未來路徑。
  • 啟發。我們要做的是激勵作者願意按照我們的要求進行修改。
  • 必要時。我們期望作者會閱讀我們張貼的所有內容;我們必須尊重他們的時間和努力,只在必要時才張貼。
  • 親切。有多種方式可以呈現相同的回饋;我們需要確保自己的言詞是善意的、支持性的和建設性的。

在提供有效評論的同時,思考是完全可能的。以上討論的概念並不排除指出您在 PR 中發現的任何問題。如果貢獻者不知道需要改進的地方,他們就沒有機會改進他們的貢獻。重要的是要注意您提出回饋的方式。嘗試將您的評論非個人化。您可以說「這段程式碼有待改進」,而不是「您犯了個錯」。檢閱程式碼,而非作者。

除了找出需要改進的地方之外,記得提供正面的回饋也很重要。舉例來說,如果改動特別有用、做得特別巧妙,或是介紹了您不知道的 API,請讓作者知道!永遠不要低估指出某人做得對或做得好的地方的效果,在這個情況中,您所指出的其他東西都是需要解決的問題。

GitHub 閱讀建議

GitHub 的審查介面有一個變更建議機制,您可以提供您所建議的確切變更,以取代現有的內容。請記住,這些建議的變更在被接受並提交之前,是不會經過預提交(pre-commit)和著色(linting)檢查的。因此,此功能應該用於較小的變更,因為建議的變更越大,就越有可能引入問題。