Testing: add a smoke test for JSON snippets in `docs/settings`
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 65/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Área
- devops, documentation, testing
Línea de trabajo
Inspecciona los fragmentos JSON de docs/settings/ y la configuración existente de pruebas o CI. Después, lee docs/testing.md para ver cómo se documentan las comprobaciones. Añade una comprobación de JSON válido y literales similares a tokens, y documenta cómo ejecutarla. La tarea estará terminada cuando la comprobación cubra docs/settings/*.json y falle si hay JSON no válido o un valor similar a un token incluido en un commit.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Python
- Estrellas
- 22
- Forks
- 4
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de openapi/mcp-server
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
openapi/mcp-server#33 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
openapi/mcp-server#29 ·
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 73/100
openapi/mcp-server#25 ·
-
Testing: add a host-agnostic smoke test checklist for OpenClaw, NanoClaw, and NemoClaw-style clientsAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
openapi/mcp-server#24 ·
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
openapi/mcp-server#21 ·
Todos los issues de openapi/mcp-server
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
PolicyEngine/policyengine-us#10262 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
kellyjonbrazil/jc#788 ·
Los mantenedores suelen responder en 2 días
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
`/search.json` ignores the documented `editions.sort` parameterPosiblemente ocupada @PranavD2905 la tomó hoy. AbiertoAffects: Server Good First Issue Module: Solr Needs: Triage Theme: Public APIs Theme: Search
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
internetarchive/openlibrary#13989 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
bug P2: misleading query
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
jeffknupp/association#478 ·