Clarify commit suggestions

オープン
#39 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
半日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
git
領域
documentation

調査の方向性

Collaborative Distributed Science Guide のリンク先の「Formatting and Naming Conventions」セクションから始め、現在の commit に関するガイダンスを確認します。完了条件は、そのセクションが commit メッセージの目的、可読性、実施した作業の理解を明確に説明し、優れた機械可読な commit の実践へのリンクを含め、変更がなぜ行われるのかを強調していることです。

索引モデルが issue の本文から書いたものです。

説明

design documentation help wanted question

The Formatting and Naming Conventions section could use a re-visit. I think we need to elevate the commit portion, but also make it more in-line with practice. We should summarize the purpose of commit messages, highlighting important aspects of readability and understanding processes done. Then also link to good practices for, e.g., machine-readability and such, but the ultimate goal of understandable commits (why is this change happening) needs to be expressed clearly.

主要言語
Python
スター
1
フォーク
1
平均マージ
6日 1時間
マージ済み PR(30日)
1

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Imageomics/Collaborative-distributed-science-guide のほかの issue

Imageomics/Collaborative-distributed-science-guide の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。