Add a checklist of standard tasks to the PR template & CONTRIBUTING.md

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

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
82/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
swift
領域
documentation

調査の方向性

まず既存の PR テンプレートと CONTRIBUTING.md を見つけ、両方を最初から最後まで読んで、現在のトーンとセクション構成を確認します。issue 内のリストをチェックリスト項目に変え、Scripts/format.sh、swift test、および Sources/ArgumentParser/Documentation.docc 配下の DocC ソースを適切な場所でリンクします。完了とは、両方のファイルが同じチェックリストを含み、メンテナーが PR で各項目にチェックを付けられる状態です。

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

説明

documentation

A lot of PRs don't seem to have updated various subsystems or files that should also have been updated to correspond with the changes from the PR (see list below).

To avoid oversights, please add a checklist of standard tasks to the PR template & CONTRIBUTING.md (& wherever else is advisable), including subsystems / files that should be updated to correspond with included changes when necessary:

  • Input validation (if / when it is implemented)
  • Help output
  • ToolInfo (including which versions should be updated)
  • Completions
  • Formatting (via Scripts/format.sh)
  • Documentation (under Sources/ArgumentParser/Documentation.docc, maybe with a link to mappings from Swift directories or files to md files)
  • Documentation (DocC in Swift files)
  • Adding / updating tests (maybe with a link to tests that should be updated per Swift directory and/or file)
  • Testing (swift test)
  • Etc.
主要言語
Swift
スター
3.8k
フォーク
436
平均マージ
4日 11時間
マージ済み PR(30日)
2

環境構築

はじめの一歩

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

apple/swift-argument-parser のほかの issue

apple/swift-argument-parser の issue をすべて見る

似ている issue

Swift の issue をもっと見る

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

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