Testing: add a smoke test for JSON snippets in `docs/settings`
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 65/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 领域
- devops, documentation, testing
调研方向
检查 docs/settings/ 下的 JSON 片段和现有的测试或 CI 配置，然后阅读 docs/testing.md，了解如何编写检查项文档。添加检查以验证 JSON 有效并检测类似令牌的字面值，同时记录运行方法。完成标准是：该检查覆盖 docs/settings/*.json，并在 JSON 无效或提交中包含类似令牌的值时失败。
由索引模型根据 Issue 内容生成。
描述
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
- Open the files in
docs/settings/. - Notice they are user-facing configuration examples.
- 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.
- 主要语言
- Python
- 星标
- 22
- 派生
- 4
- 平均合并
- 6 分钟
- 30 天内合并 PR
- 1
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
openapi/mcp-server 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
openapi/mcp-server#33 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
openapi/mcp-server#29 ·
-
难度 1/5 1-3 小时 新手友好度 73/100
openapi/mcp-server#25 ·
-
Testing: add a host-agnostic smoke test checklist for OpenClaw, NanoClaw, and NemoClaw-style clients未关闭
难度 2/5 1-3 小时 新手友好度 72/100
openapi/mcp-server#24 ·
-
难度 1/5 1-3 小时 新手友好度 72/100
openapi/mcp-server#21 ·
查看 openapi/mcp-server 的全部 Issue
相似的 Issue
-
Support .aac audio uploads可能已有人在做 @julien731 今天认领。 未关闭feature
难度 2/5 1-3 小时 新手友好度 78/100
nimblehq/audio-transcriber#153 ·
-
help wanted
难度 2/5 1-3 小时 新手友好度 68/100
antonyrag/ragleap-core#1062 ·
-
needs-triage
难度 2/5 1-3 小时 新手友好度 76/100
gke-labs/kube-agents#4321 ·
维护者通常 1 天内回复
-
enhancement help wanted
难度 2/5 1-3 小时 新手友好度 76/100
Git-Hospital/githealthcheck#61 ·
维护者通常 1 天内回复
-
changelog investigate
难度 2/5 1-3 小时 新手友好度 67/100
ramnes/notion-sdk-py#433 ·