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

Testing: add a smoke test for JSON snippets in `docs/settings`

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

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
65/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
json, python, shell
Lĩnh vực
devops, documentation, testing

Hướng nghiên cứu

Kiểm tra các đoạn JSON trong docs/settings/ và thiết lập kiểm thử hoặc CI hiện có, sau đó đọc docs/testing.md để xem cách tài liệu hóa các bước kiểm tra. Thêm bước kiểm tra JSON hợp lệ và các giá trị literal giống token, đồng thời ghi lại cách chạy bước kiểm tra đó. Hoàn thành khi bước kiểm tra bao quát docs/settings/*.json và thất bại nếu JSON không hợp lệ hoặc có giá trị giống token đã được đưa vào commit.

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

Mô tả

enhancement good first issue help wanted

Opened by @francescobianco from local draft 09-docs-settings-smoke-test.md.

Summary

A few config files under docs/settings/ are clearly meant to be copied into AI clients. It would be useful to have a tiny CI check that validates these snippets stay parseable and do not drift away from the README.

Reproduction

  1. Open the files in docs/settings/.
  2. Notice they are user-facing configuration examples.
  3. There is no obvious test making sure the examples remain valid JSON and safe placeholders.

Expected

At least a small test or script that:

  • validates JSON syntax
  • checks for placeholder values instead of token-like literals
  • optionally verifies referenced URLs and keys stay aligned with the docs

Actual

Example config quality is enforced manually.

Why this is a good first issue

The scope is small and can likely be implemented as a shell or pytest check.

Suggested acceptance criteria

  • Add one automated check for docs/settings/*.json.
  • Fail if a token-looking literal is committed again.
  • Document the check in docs/testing.md.
Ngôn ngữ chính
Python
Star
22
Fork
4
Không có pull request nào được merge trong 30 ngày

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

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 openapi/mcp-server

Tất cả issue của openapi/mcp-server

Issue tương tự

Thêm issue về Python

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.