Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#64,553 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
84/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
go
Lĩnh vực
documentation, testing

Hướng nghiên cứu

Đọc pkg/parser/schemas/main_workflow_schema.json và docs/src/content/docs/reference/frontmatter.md để hiểu các thuộc tính của schema và các tham chiếu name: được đặt trong dấu backtick của trang. Thêm một Go test để kiểm tra rằng mọi thuộc tính cấp cao nhất đều được ghi chép, kèm lý do giải thích trong comment cho mọi ngoại lệ được đưa vào allowlist. Hoàn tất khi test pass với các field hiện tại và fail nếu một field schema chưa được ghi chép được thêm vào.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
Go
Star
5.4k
Fork
584
Merge trung bình
3 giờ 20 phút
Pull request đã merge (30 ngày)
830

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/gh-aw

Tất cả issue của github/gh-aw

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.