Add pre-merge checklist in core developer guide

オープン 初心者向け
#653 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る

メンテナーはふだん 2 日以内に返信

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

評価

難易度
1/5
見積もり時間
1〜3時間
初心者へのやさしさ
62/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
領域
documentation

調査の方向性

issueにリンクされているdocs/developers/coredev/core_dev_guide.mdのレビューのセクションを編集してください。まずそのセクションを読み、提案するマージ前チェックリストを既存のガイダンスに沿わせます。最終チェックの手順と、その自動化における役割を説明するかどうかを決めてください。ガイドに列挙されたチェックと、最終チェックとマージ待機期間の違いが記載されていれば完了です。

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

説明

Our core developer guide has a section on reviewing, but it is missing essential information about merge-time conventions/etiquette. Especially now that @willingc is advocating for getting rid of the "ready to merge" wait period, I think it's important to add to the guide everything that needs to happen before a PR is merged:

  • check the type label type (feature, label, performance, etc)
  • check the milestone
  • check discussion comments are addressed or an issue is made to keep track of remaining to-dos
  • make sure the title still reflects the state/purpose of the PR
  • make sure the description reflects the current state/purpose of the PR (it's encouraged to leave the original description underneath under the heading "original description", since it provides the context for the subsequent discussion on the PR itself. However, the description becomes the commit message, so it should reflect the status of the PR at the time of merging.)

Some of those checks should ideally be automated, so we could perhaps rename "ready to merge" to "final checks" and keep it only for the automations, not for the wait period.

主要言語
Makefile
スター
13
フォーク
71
平均マージ
3日 8時間
マージ済み PR(30日)
31

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

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

napari/docs のほかの issue

napari/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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