Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Add an API diff workflow

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
45/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
github-actions, swift
領域
api, ci-cd

調査の方向性

まず、既存の API breakage ワークフローを読み、pull request 上でどのように実行されるかを追跡します。swiftinterface の diff、または library evolution を使用しないパッケージ向けの同等のものを取得する方法を確認し、それを PR コメントとして提示する場合と GitHub check の出力として提示する場合を比較します。完了条件は、ワークフローが API diff を表示し、含めるモジュールを設定できることです。

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

説明

In addition to the existing API breakage workflow, it'd be helpful to see the diff of the swiftinterface file (or equivalent for packages that can't build with library evolution enabled) that the PR is making.

When a package has a large diff where most of the code is implementation, it can be difficult to spot the exact API changes it's making.

There are a few ways this could be surfaced to the user:

  • Option A: A comment posted by the workflow back on the PR
  • Option B: The workflow just printing the diff and the user needing to click on the GitHub check link and reviewing it manually

Either would be fine to start.

Presumably, this would come with some configurability, mainly the list of modules to diff - there might be internal modules that the maintainer might not care about seeing the diff of, and might even cause noise.

主要言語
Swift
スター
115
フォーク
57
平均マージ
1日 8時間
マージ済み PR（30日）
3

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

swiftlang/github-workflows のほかの issue

swiftlang/github-workflows の issue をすべて見る

似ている issue

Swift の issue をもっと見る

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

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