Testing: add a smoke test for JSON snippets in `docs/settings`
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 65/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Ambito
- devops, documentation, testing
Direzione di ricerca
Esamina gli snippet JSON in docs/settings/ e la configurazione esistente dei test o della CI, poi leggi docs/testing.md per vedere come vengono documentati i controlli. Aggiungi un controllo per verificare la validità del JSON e individuare valori letterali simili a token, e documenta come eseguirlo. Il lavoro è concluso quando il controllo copre docs/settings/*.json e fallisce in presenza di JSON non valido o di un valore simile a un token incluso in un commit.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Python
- Stelle
- 22
- Fork
- 4
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di openapi/mcp-server
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
openapi/mcp-server#33 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
openapi/mcp-server#29 ·
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 73/100
openapi/mcp-server#25 ·
-
Testing: add a host-agnostic smoke test checklist for OpenClaw, NanoClaw, and NemoClaw-style clientsAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
openapi/mcp-server#24 ·
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
openapi/mcp-server#21 ·
Tutte le issue di openapi/mcp-server
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
[Bug] to_ical lexicographical/default sorting moves URL property between two X-WR- propertiesAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
collective/icalendar#1968 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Deferred from #1869: Complete the companion pytest guardrail update noted in the PR description...Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
NousResearch/hermes-agent#140958 ·
I maintainer di solito rispondono entro 1 giorno
-
Bug triage/confirmed
Difficoltà 2/5 Mezza giornata Idoneità per principianti 85/100
agentscope-ai/agentscope#3355 ·
I maintainer di solito rispondono entro 2 giorni