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

docs(router): align RouteMatch API reference with the current public contract

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

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

@soheilnikroo がすでに取り組んでいます。

2026年7月12日 から。

  • #7800 @soheilnikroo による — オープン

評価

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

調査の方向性

docs/router/api/router/RouteMatchType.md から始め、issue に記載された公開コントラクトを指針として、packages/router-core/src/Matches.ts と比較してください。廃止されたフィールドと内部フィールドを削除し、指定された公開フィールドと cause の値を追加して、ページ全体の正確性を確認してください。ライフサイクル専用の状態を含まず、リファレンスが意図された公開 RouteMatch API と一致すれば完了です。

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

説明

Goal

Bring the RouteMatch API reference in line with the current public contract.

Scope

  • Remove obsolete showPending and fetchedAt entries from docs/router/api/router/RouteMatchType.md.
  • Add fullPath using its route-specific type, Route['fullPath'].
  • Add index and explain its ordering within the matched route array.
  • Update cause to include 'preload'.
  • Keep internal and lifecycle-specific match state out of the reference, including displayPendingPromise, fetchCount, preload, invalid, headers, and globalNotFound.
  • Review the complete page against packages/router-core/src/Matches.ts so the reference describes the intentional public API.

Related Work

This continues the RouteMatch reference update started in #4894

主要言語
TypeScript
スター
15.1k
フォーク
1.9k
平均マージ
1日 14時間
マージ済み PR(30日)
127

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

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

TanStack/router のほかの issue

TanStack/router の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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