Clarify "Co-authored-by" usage in PRs
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 52/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 停滞
- 技術スタック
- github
調査の方向性
devguide の「Handling Others' Code」セクションの第 4 段落を読み、コンテキストを把握するためにリンク先の Discourse トピックを確認してください。重要なレビューや提案変更による貢献に対して GitHub の Co-authored-by: 行を使用すべきタイミングを明確にし、squash、automerge、直接の提案変更との関係も含めてください。
索引モデルが issue の本文から書いたものです。
説明
As brought up in a Discourse committers topic, the devguide could be more clear about Pull Request attribution on GitHub.
Specifically, in the fourth paragraph of "Handling Others' Code", the Co-authored-by: feature of GitHub is mentioned, but the use case of it is not defined.
Since GitHub will automatically attribute the primary author of the PR when using "squash and merge" or the "automerge", the Co-authored-by: is useful to add just prior to merging for anyone that significantly contributed to the PR, either via review or direct suggested changes. When using the GitHub UI to directly commit a suggested change to the PR, a Co-authored-by: line is automatically added to the commit message. Otherwise though, it has to be done manually for people other than the author to be attributed for contributing to the PR.
With this being a rather substantial part of the workflow for GitHub PRs, it seems to be worthwhile to mention when Co-authored-by: should be used rather than mentioning the feature without elaborating further.
- 主要言語
- Python
- スター
- 2.1k
- フォーク
- 1k
- 平均マージ
- 2日 12時間
- マージ済み PR(30日)
- 12
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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
python/devguide の issue をすべて見る
似ている issue
-
🐛 Bug 🔔 Pending processing
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
jumpserver/jumpserver#17584 ·
-
link-check link-check:sphinx-theme
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
modelscope/DiffSynth-Studio#1702 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
qgis/QGIS-Documentation#11275 ·
-
bug priority:normal ready-for-dev
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
OpenHands/extensions#626 · コメント 1 件 ·