Update GH PR Guide Page

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

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

評価

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

調査の方向性

リンクされている GitHub PR Guide ページから始め、最初の2つのセクションを GitHub の最近の更新と比較し、スクリーンショット、レビュアーの選定、ブランチ保護に焦点を当てます。提供されている squash-merge と branch-scoping のガイダンスを使って、要求された「4. Merge Your Pull Request」セクションを追加します。これらの更新と新しいセクションがガイドページに正確に反映された時点で作業は完了です。

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

説明

documentation enhancement

Further updates to the first two sections of the GitHub PR Guide are still needed to align with GitHub's recent updates, though this is more about updating screenshots than actual content. There are a few more features that may be worth highlighting, but a major overhaul is not required.

One more thing to note in that section is actually picking a reviewer or reviewers, i.e., that it should be those that are most familiar with the content after the author and that they must have write access to the repo for it to satisfy branch protections (arguably, this should be covered by most familiar with content).

Additionally (pulling from a discussion in a private repo), let's make a section: "4. Merge Your Pull Request" which will include information about the merging options.

Basics on Squash Merge from @johnbradley's original Two Repo problem draft:

  • Often there are many messy commits that should be reduced to meaningful commits.
  • One easy way to reduce the messy commits into a single commit is using a Squash and merge Pull Request.

Paired with the scope note mentioned in my comment:

We should be sure to emphasize the fact that once a branch is squash merged into main, it can't continue to be used for development, so they should be scoped. Also, that they should be scoped so the squash merge makes sense and can still be used to tell the story (for instance, one feature change and the associated adjustments to tests).

主要言語
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 を短くまとめたダイジェスト。