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

[deep-report] Add a schema-to-docs parity test for reference/frontmatter.md

クローズ 初心者向け
#64,553 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
84/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
go

調査の方向性

pkg/parser/schemas/main_workflow_schema.json と docs/src/content/docs/reference/frontmatter.md を読み、スキーマのプロパティとページ内のバッククォートで囲まれた name: 参照を理解してください。トップレベルの各プロパティがドキュメント化されていることを確認する Go テストを追加し、allowlist に含める例外にはコメントで理由を記述してください。現在のフィールドでテストがパスし、ドキュメント化されていないスキーマフィールドが導入された場合に失敗すれば完了です。

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

説明

automation code-quality cookie improvement quick-win task-mining
Description

Nothing currently guards against the frontmatter reference page drifting from pkg/parser/schemas/main_workflow_schema.json — the audit that found 11 undocumented fields (see the companion docs issues from this same analysis) had to be done manually. Add a Go test that loads the top-level properties of main_workflow_schema.json and asserts each appears as a backticked `name:` reference in docs/src/content/docs/reference/frontmatter.md. Keep a small, justified allowlist for genuinely internal/deprecated fields (each allowlist entry needs a comment explaining why it's exempt).

Expected Impact

Prevents this exact gap from recurring: any future schema field added without a corresponding docs update fails CI immediately instead of silently drifting for months.

Suggested Agent

GitHub Copilot coding agent (Go test + parser package).

Estimated Effort

Medium (1-4 hours)

Data Source

DeepReport Intelligence Briefing — 2026-09-30, sourced from Repository Quality Improvement Report #64505 (Task 3, marked High priority by the source report).

Generated by 🔬 Deep Report · claude · agent · 311.3 AIC · ⌖ 8.86 AIC · ⊞ 7.3K · ◷

  • expires on Oct 2, 2026, 10:46 AM UTC-08:00
主要言語
Go
スター
5.4k
フォーク
584
平均マージ
3時間 20分
マージ済み PR(30日)
830

環境構築

Codespaces で開く

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

はじめの一歩

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

github/gh-aw のほかの issue

github/gh-aw の issue をすべて見る

似ている issue

Go の issue をもっと見る

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

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