Improve the "Making Good PRs" section
還沒有人認領這個 Issue。
評估
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 35/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
研究方向
首先在開發者指南中找到「Making Good PRs」區段，並檢視周圍的文件階層。決定該區段應如何說明準確、簡潔的 pull request 標題與描述，以及它是否應位於更高層級。完成的標準是，指南及其位置清楚地反映 issue 建議的改進。
由索引模型根據 Issue 內容生成。
描述
I often see PRs with misleading or vague titles. This is problematic, as the PR titles often end up being the commit titles, and commit titles are one of the most important tools we have when searching for historic changes. Bad titles impact maintainability.
Suggested edits:
- Enforce a strict title format
- Promote writing accurate and concise PR titles/descriptions
Perhaps the "Making Good PRs" section can be further promoted. Would it make sense to extract it and move it a level up in the doc hierarchy?
- 主要語言
- Python
- 星號
- 2.1k
- 分支
- 1k
- 平均合併
- 2 天 12 小時
- 30 天內合併 PR
- 12
貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
python/devguide 的其他 Issue
-
type-feature
難度 2/5 1-3 小時 新手友好度 68/100
-
type-feature
難度 2/5 1-3 小時 新手友好度 68/100
-
topic-building python type-feature
難度 2/5 1-3 小時 新手友好度 65/100
-
needs: decision topic-test type-bug
難度 2/5 1-3 小時 新手友好度 78/100
-
topic-dev process type-feature
難度 2/5 1-3 小時 新手友好度 62/100
相似的 Issue
-
fix: inaccuracy ⚠️
難度 2/5 1-3 小時 新手友好度 72/100
uabrc/uabrc.github.io#1255 · 1 則留言 ·
-
難度 2/5 1-3 小時 新手友好度 84/100
ethereum-optimism/factory#64 ·
-
難度 2/5 1-3 小時 新手友好度 90/100
duckdb/duckdb-python#627 ·
-
難度 2/5 1-3 小時 新手友好度 68/100
-
documentation
難度 1/5 1 小時以內 新手友好度 78/100
Qiskit/qiskit-addon-sqd#376 ·