@mcptoolshop/shipcheck 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/CHANGELOG.md +40 -0
  2. package/README.es.md +81 -81
  3. package/README.fr.md +81 -81
  4. package/README.hi.md +81 -81
  5. package/README.it.md +81 -81
  6. package/README.ja.md +81 -81
  7. package/README.md +17 -10
  8. package/README.pt-BR.md +81 -81
  9. package/README.zh.md +81 -81
  10. package/bin/shipcheck.mjs +15 -7
  11. package/package.json +5 -1
package/CHANGELOG.md ADDED
@@ -0,0 +1,40 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
6
+
7
+ ## [1.0.1] - 2026-02-27
8
+
9
+ ### Added
10
+ - Trust model paragraph in README (Ship Gate A2)
11
+ - Structured error shape in CLI — `fail()` with code/message/hint (Ship Gate B1)
12
+ - Proper exit codes: 0 ok, 1 user error, 2 runtime error (Ship Gate B2)
13
+ - `verify` script in package.json (Ship Gate D1)
14
+ - CI workflow with npm audit (Ship Gate D3)
15
+ - CHANGELOG.md included in npm tarball (Ship Gate D5)
16
+ - package-lock.json committed (Ship Gate D7)
17
+ - SHIP_GATE.md filled with actual audit results (23/31 checked, 14 skipped, 100% pass)
18
+
19
+ ### Changed
20
+ - Scorecard in README reflects actual `shipcheck audit` results, not estimates
21
+
22
+ ## [1.0.0] - 2026-02-27
23
+
24
+ ### Overview
25
+
26
+ **First stable release.** Product standards for MCP Tool Shop, extracted from the mcp-voice-soundboard remediation.
27
+
28
+ ### Added
29
+
30
+ - **Ship Gate** — 27 hard-gate + 4 soft-gate pre-release checklist with applicability tags
31
+ - **Error Contract** — 2-tier structured error standard (shape mandatory everywhere, base type for CLI/MCP/desktop)
32
+ - **Error Code Registry** — namespaced prefixes, stable once released, each maps to exit code + default hint
33
+ - **Security Baseline** template — report email, response timeline, threat scope
34
+ - **Handbook** template — operational field manual skeleton for complex tools
35
+ - **Scorecard** template — pre/post remediation scoring
36
+ - **ADOPTION.md** — apply shipcheck to any repo in <30 minutes
37
+
38
+ ### Reference implementation
39
+
40
+ - [mcp-voice-soundboard](https://github.com/mcp-tool-shop-org/mcp-voice-soundboard) — first repo to pass Ship Gate (46/50)
package/README.es.md CHANGED
@@ -1,64 +1,64 @@
1
- <p align="center">
2
- <a href="README.ja.md">日本語</a> | <a href="README.zh.md">中文</a> | <a href="README.md">English</a> | <a href="README.fr.md">Français</a> | <a href="README.hi.md">हिन्दी</a> | <a href="README.it.md">Italiano</a> | <a href="README.pt-BR.md">Português (BR)</a>
3
- </p>
4
-
1
+ <p align="center">
2
+ <a href="README.ja.md">日本語</a> | <a href="README.zh.md">中文</a> | <a href="README.md">English</a> | <a href="README.fr.md">Français</a> | <a href="README.hi.md">हिन्दी</a> | <a href="README.it.md">Italiano</a> | <a href="README.pt-BR.md">Português (BR)</a>
3
+ </p>
4
+
5
5
  <p align="center">
6
6
  <img src="https://raw.githubusercontent.com/mcp-tool-shop-org/brand/main/logos/shipcheck/readme.png" alt="Shipcheck" width="400">
7
7
  </p>
8
-
8
+
9
9
  <p align="center">
10
10
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="MIT License"></a>
11
11
  <a href="https://mcp-tool-shop-org.github.io/shipcheck/"><img src="https://img.shields.io/badge/Landing_Page-live-blue" alt="Landing Page"></a>
12
12
  </p>
13
-
13
+
14
14
  <p align="center">
15
15
  Product standards for MCP Tool Shop.<br>
16
16
  Templates, contracts, and adoption guides that define what "done" means before anything ships.
17
17
  </p>
18
-
18
+
19
19
  ---
20
-
21
- ## ¿Por qué?
22
-
23
- Antes, "hecho" significaba que el código funcionaba. Eso ya no es suficiente. Un producto es código + seguridad + manejo de errores + documentación + identidad + buenas prácticas de publicación. Shipcheck define el estándar.
24
-
25
- ## ¿Qué hay aquí?
26
-
27
- | Estándar | ¿Qué cubre? |
28
- |----------|----------------|
29
- | [Ship Gate](templates/SHIP_GATE.md) | Lista de verificación de pre-lanzamiento con 27 puntos obligatorios + 4 puntos opcionales. |
30
- | [Error Contract](contracts/error-contract.md) | Estándar estructurado de manejo de errores con registro de código. |
31
- | [Security Baseline](templates/SECURITY.md) | Correo electrónico de informe, plazo de respuesta, alcance de las amenazas. |
32
- | [Handbook](templates/HANDBOOK.md) | Manual de operación para herramientas complejas. |
33
- | [Scorecard](templates/SCORECARD.md) | Puntuación antes/después de la corrección. |
34
- | [Adoption Guide](ADOPTION.md) | Aplica Shipcheck a cualquier repositorio en menos de 30 minutos. |
35
-
36
- ## Cómo empezar
37
-
38
- 1. Lee [ADOPTION.md](ADOPTION.md)
39
- 2. Copia `templates/SHIP_GATE.md` en la raíz de tu repositorio.
40
- 3. Marca los elementos aplicables, y marca los no aplicables con `SKIP:`.
41
- 4. Publica cuando todos los puntos obligatorios hayan sido superados.
42
-
43
- ## Cómo funciona
44
-
45
- Las **etapas obligatorias** (A-D) bloquean el lanzamiento:
46
-
47
- - **A. Seguridad básica** — SECURITY.md, modelo de amenazas, sin secretos, sin telemetría, postura de seguridad predeterminada.
48
- - **B. Manejo de errores** — estructura de errores definida (código/mensaje/sugerencia/reintentable), salida segura, degradación controlada.
49
- - **C. Documentación para el usuario** — README, CHANGELOG, LICENCIA, documentación de la herramienta.
50
- - **D. Buenas prácticas de publicación** — verificación de scripts, alineación de versiones, análisis de dependencias, archivo de bloqueo.
51
-
52
- La **etapa opcional** (E) no bloquea, pero define el "conjunto completo":
53
-
54
- - **E. Identidad** — logotipo, traducciones, página de inicio, metadatos del repositorio.
55
-
56
- La etapa indica **qué** debe ser cierto, no **cómo** implementarlo. Las etiquetas de aplicabilidad (`[all]`, `[npm]`, `[mcp]`, `[cli]`, `[desktop]`, `[vsix]`, `[container]`) evitan que se marquen casillas de verificación innecesariamente en repositorios donde los elementos no son aplicables.
57
-
58
- ## Contrato de errores de un vistazo
59
-
60
- **Nivel 1 — Estructura (obligatorio en todas partes):**
61
-
20
+
21
+ ## ¿Por qué?
22
+
23
+ Antes, "hecho" significaba que el código funcionaba. Eso ya no es suficiente. Un producto es código + seguridad + manejo de errores + documentación + identidad + buenas prácticas de publicación. Shipcheck define el estándar.
24
+
25
+ ## ¿Qué hay aquí?
26
+
27
+ | Estándar | ¿Qué cubre? |
28
+ |----------|----------------|
29
+ | [Ship Gate](templates/SHIP_GATE.md) | Lista de verificación de pre-lanzamiento con 27 puntos obligatorios + 4 puntos opcionales. |
30
+ | [Error Contract](contracts/error-contract.md) | Estándar estructurado de manejo de errores con registro de código. |
31
+ | [Security Baseline](templates/SECURITY.md) | Correo electrónico de informe, plazo de respuesta, alcance de las amenazas. |
32
+ | [Handbook](templates/HANDBOOK.md) | Manual de operación para herramientas complejas. |
33
+ | [Scorecard](templates/SCORECARD.md) | Puntuación antes/después de la corrección. |
34
+ | [Adoption Guide](ADOPTION.md) | Aplica Shipcheck a cualquier repositorio en menos de 30 minutos. |
35
+
36
+ ## Cómo empezar
37
+
38
+ 1. Lee [ADOPTION.md](ADOPTION.md)
39
+ 2. Copia `templates/SHIP_GATE.md` en la raíz de tu repositorio.
40
+ 3. Marca los elementos aplicables, y marca los no aplicables con `SKIP:`.
41
+ 4. Publica cuando todos los puntos obligatorios hayan sido superados.
42
+
43
+ ## Cómo funciona
44
+
45
+ Las **etapas obligatorias** (A-D) bloquean el lanzamiento:
46
+
47
+ - **A. Seguridad básica** — SECURITY.md, modelo de amenazas, sin secretos, sin telemetría, postura de seguridad predeterminada.
48
+ - **B. Manejo de errores** — estructura de errores definida (código/mensaje/sugerencia/reintentable), salida segura, degradación controlada.
49
+ - **C. Documentación para el usuario** — README, CHANGELOG, LICENCIA, documentación de la herramienta.
50
+ - **D. Buenas prácticas de publicación** — verificación de scripts, alineación de versiones, análisis de dependencias, archivo de bloqueo.
51
+
52
+ La **etapa opcional** (E) no bloquea, pero define el "conjunto completo":
53
+
54
+ - **E. Identidad** — logotipo, traducciones, página de inicio, metadatos del repositorio.
55
+
56
+ La etapa indica **qué** debe ser cierto, no **cómo** implementarlo. Las etiquetas de aplicabilidad (`[all]`, `[npm]`, `[mcp]`, `[cli]`, `[desktop]`, `[vsix]`, `[container]`) evitan que se marquen casillas de verificación innecesariamente en repositorios donde los elementos no son aplicables.
57
+
58
+ ## Contrato de errores de un vistazo
59
+
60
+ **Nivel 1 — Estructura (obligatorio en todas partes):**
61
+
62
62
  ```json
63
63
  {
64
64
  "code": "INPUT_TEXT_EMPTY",
@@ -67,39 +67,39 @@ La etapa indica **qué** debe ser cierto, no **cómo** implementarlo. Las etique
67
67
  "retryable": false
68
68
  }
69
69
  ```
70
-
71
- **Nivel 2 — Tipo base + códigos de salida (CLI/MCP/escritorio):**
72
-
73
- | Código de salida | Significado |
74
- |-----------|---------|
75
- | 0 | OK |
76
- | 1 | Error del usuario (entrada incorrecta, configuración faltante) |
77
- | 2 | Error en tiempo de ejecución (fallo, fallo del backend) |
78
- | 3 | Éxito parcial (algunos elementos tuvieron éxito) |
79
-
80
- Los códigos de error utilizan prefijos con espacio de nombres: `IO_`, `CONFIG_`, `PERM_`, `DEP_`, `RUNTIME_`, `PARTIAL_`, `INPUT_`, `STATE_`. Los códigos son estables una vez que se publican.
81
-
82
- ## Implementación de referencia
83
-
84
- [mcp-voice-soundboard](https://github.com/mcp-tool-shop-org/mcp-voice-soundboard) fue el primer repositorio en superar la etapa de publicación, obteniendo una puntuación de **46/50** después de la corrección.
85
-
86
- ## Cuadro de puntuación
87
-
88
- | Categoría | Puntuación | Notas |
89
- |----------|-------|-------|
90
- | A. Seguridad | 10/10 | SECURITY.md, sin código ejecutable, sin recopilación de datos. |
91
- | B. Manejo de errores | N/A | Repositorio de estándares — no hay código para generar errores. |
92
- | C. Documentación para el usuario | 10/10 | README, CHANGELOG, ADOPTION, todas las plantillas documentadas. |
93
- | D. Buenas prácticas de publicación | 8/10 | Sin código para verificar/probar, todas las versiones de los estándares. |
94
- | E. Identidad | 10/10 | Logotipo, traducciones, página de inicio, metadatos. |
95
- | **Total** | **38/40** | B excluido (no aplicable). |
96
-
97
- ## Licencia
98
-
99
- [MIT](LICENSE)
100
-
70
+
71
+ **Nivel 2 — Tipo base + códigos de salida (CLI/MCP/escritorio):**
72
+
73
+ | Código de salida | Significado |
74
+ |-----------|---------|
75
+ | 0 | OK |
76
+ | 1 | Error del usuario (entrada incorrecta, configuración faltante) |
77
+ | 2 | Error en tiempo de ejecución (fallo, fallo del backend) |
78
+ | 3 | Éxito parcial (algunos elementos tuvieron éxito) |
79
+
80
+ Los códigos de error utilizan prefijos con espacio de nombres: `IO_`, `CONFIG_`, `PERM_`, `DEP_`, `RUNTIME_`, `PARTIAL_`, `INPUT_`, `STATE_`. Los códigos son estables una vez que se publican.
81
+
82
+ ## Implementación de referencia
83
+
84
+ [mcp-voice-soundboard](https://github.com/mcp-tool-shop-org/mcp-voice-soundboard) fue el primer repositorio en superar la etapa de publicación, obteniendo una puntuación de **46/50** después de la corrección.
85
+
86
+ ## Cuadro de puntuación
87
+
88
+ | Categoría | Puntuación | Notas |
89
+ |----------|-------|-------|
90
+ | A. Seguridad | 10/10 | SECURITY.md, sin código ejecutable, sin recopilación de datos. |
91
+ | B. Manejo de errores | N/A | Repositorio de estándares — no hay código para generar errores. |
92
+ | C. Documentación para el usuario | 10/10 | README, CHANGELOG, ADOPTION, todas las plantillas documentadas. |
93
+ | D. Buenas prácticas de publicación | 8/10 | Sin código para verificar/probar, todas las versiones de los estándares. |
94
+ | E. Identidad | 10/10 | Logotipo, traducciones, página de inicio, metadatos. |
95
+ | **Total** | **38/40** | B excluido (no aplicable). |
96
+
97
+ ## Licencia
98
+
99
+ [MIT](LICENSE)
100
+
101
101
  ---
102
-
102
+
103
103
  <p align="center">
104
104
  Built by <a href="https://mcp-tool-shop.github.io/">MCP Tool Shop</a>
105
105
  </p>
package/README.fr.md CHANGED
@@ -1,64 +1,64 @@
1
- <p align="center">
2
- <a href="README.ja.md">日本語</a> | <a href="README.zh.md">中文</a> | <a href="README.es.md">Español</a> | <a href="README.md">English</a> | <a href="README.hi.md">हिन्दी</a> | <a href="README.it.md">Italiano</a> | <a href="README.pt-BR.md">Português (BR)</a>
3
- </p>
4
-
1
+ <p align="center">
2
+ <a href="README.ja.md">日本語</a> | <a href="README.zh.md">中文</a> | <a href="README.es.md">Español</a> | <a href="README.md">English</a> | <a href="README.hi.md">हिन्दी</a> | <a href="README.it.md">Italiano</a> | <a href="README.pt-BR.md">Português (BR)</a>
3
+ </p>
4
+
5
5
  <p align="center">
6
6
  <img src="https://raw.githubusercontent.com/mcp-tool-shop-org/brand/main/logos/shipcheck/readme.png" alt="Shipcheck" width="400">
7
7
  </p>
8
-
8
+
9
9
  <p align="center">
10
10
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="MIT License"></a>
11
11
  <a href="https://mcp-tool-shop-org.github.io/shipcheck/"><img src="https://img.shields.io/badge/Landing_Page-live-blue" alt="Landing Page"></a>
12
12
  </p>
13
-
13
+
14
14
  <p align="center">
15
15
  Product standards for MCP Tool Shop.<br>
16
16
  Templates, contracts, and adoption guides that define what "done" means before anything ships.
17
17
  </p>
18
-
18
+
19
19
  ---
20
-
21
- ## Pourquoi
22
-
23
- "Terminé" signifiait autrefois que le code fonctionnait. Ce n'est pas suffisant. Un produit est constitué de code + sécurité + gestion des erreurs + documentation + identité + bonnes pratiques de déploiement. Shipcheck définit les exigences.
24
-
25
- ## Ce qui se trouve ici
26
-
27
- | Standard | Ce que cela couvre |
28
- |----------|----------------|
29
- | [Ship Gate](templates/SHIP_GATE.md) | Liste de contrôle de pré-publication avec 27 critères obligatoires et 4 critères optionnels. |
30
- | [Error Contract](contracts/error-contract.md) | Norme structurée en deux niveaux pour la gestion des erreurs, avec un registre de code. |
31
- | [Security Baseline](templates/SECURITY.md) | Email de rapport, délai de réponse, étendue des risques. |
32
- | [Handbook](templates/HANDBOOK.md) | Manuel d'utilisation pour les outils complexes. |
33
- | [Scorecard](templates/SCORECARD.md) | Notation avant et après la correction des problèmes. |
34
- | [Adoption Guide](ADOPTION.md) | Appliquez Shipcheck à n'importe quel dépôt en moins de 30 minutes. |
35
-
36
- ## Démarrage rapide
37
-
38
- 1. Lisez [ADOPTION.md](ADOPTION.md)
39
- 2. Copiez `templates/SHIP_GATE.md` dans la racine de votre dépôt.
40
- 3. Cochez les éléments applicables, indiquez "SKIP:" pour les éléments non applicables.
41
- 4. Déployez lorsque tous les critères obligatoires sont remplis.
42
-
43
- ## Comment cela fonctionne
44
-
45
- Les **critères obligatoires** (A à D) bloquent la publication :
46
-
47
- - **A. Sécurité de base** — SECURITY.md, modèle de menace, pas de secrets, pas de télémétrie, posture de sécurité par défaut.
48
- - **B. Gestion des erreurs** — structure des erreurs (code/message/indice/réessayable), sortie sécurisée, dégradation progressive.
49
- - **C. Documentation pour l'utilisateur** — README, CHANGELOG, LICENSE, documentation de l'outil.
50
- - **D. Bonnes pratiques de déploiement** — vérification du script, alignement des versions, analyse des dépendances, fichier de verrouillage.
51
-
52
- Le **critère optionnel** (E) ne bloque pas, mais définit l'ensemble du produit :
53
-
54
- - **E. Identité** — logo, traductions, page d'accueil, métadonnées du dépôt.
55
-
56
- Le critère indique **ce qui** doit être vrai, et non **comment** l'implémenter. Les balises d'applicabilité (`[all]`, `[npm]`, `[mcp]`, `[cli]`, `[desktop]`, `[vsix]`, `[container]`) évitent les situations embarrassantes dans les dépôts où certains éléments ne sont pas applicables.
57
-
58
- ## Vue d'ensemble du contrat de gestion des erreurs
59
-
60
- **Niveau 1 — Structure (obligatoire partout) :**
61
-
20
+
21
+ ## Pourquoi
22
+
23
+ "Terminé" signifiait autrefois que le code fonctionnait. Ce n'est pas suffisant. Un produit est constitué de code + sécurité + gestion des erreurs + documentation + identité + bonnes pratiques de déploiement. Shipcheck définit les exigences.
24
+
25
+ ## Ce qui se trouve ici
26
+
27
+ | Standard | Ce que cela couvre |
28
+ |----------|----------------|
29
+ | [Ship Gate](templates/SHIP_GATE.md) | Liste de contrôle de pré-publication avec 27 critères obligatoires et 4 critères optionnels. |
30
+ | [Error Contract](contracts/error-contract.md) | Norme structurée en deux niveaux pour la gestion des erreurs, avec un registre de code. |
31
+ | [Security Baseline](templates/SECURITY.md) | Email de rapport, délai de réponse, étendue des risques. |
32
+ | [Handbook](templates/HANDBOOK.md) | Manuel d'utilisation pour les outils complexes. |
33
+ | [Scorecard](templates/SCORECARD.md) | Notation avant et après la correction des problèmes. |
34
+ | [Adoption Guide](ADOPTION.md) | Appliquez Shipcheck à n'importe quel dépôt en moins de 30 minutes. |
35
+
36
+ ## Démarrage rapide
37
+
38
+ 1. Lisez [ADOPTION.md](ADOPTION.md)
39
+ 2. Copiez `templates/SHIP_GATE.md` dans la racine de votre dépôt.
40
+ 3. Cochez les éléments applicables, indiquez "SKIP:" pour les éléments non applicables.
41
+ 4. Déployez lorsque tous les critères obligatoires sont remplis.
42
+
43
+ ## Comment cela fonctionne
44
+
45
+ Les **critères obligatoires** (A à D) bloquent la publication :
46
+
47
+ - **A. Sécurité de base** — SECURITY.md, modèle de menace, pas de secrets, pas de télémétrie, posture de sécurité par défaut.
48
+ - **B. Gestion des erreurs** — structure des erreurs (code/message/indice/réessayable), sortie sécurisée, dégradation progressive.
49
+ - **C. Documentation pour l'utilisateur** — README, CHANGELOG, LICENSE, documentation de l'outil.
50
+ - **D. Bonnes pratiques de déploiement** — vérification du script, alignement des versions, analyse des dépendances, fichier de verrouillage.
51
+
52
+ Le **critère optionnel** (E) ne bloque pas, mais définit l'ensemble du produit :
53
+
54
+ - **E. Identité** — logo, traductions, page d'accueil, métadonnées du dépôt.
55
+
56
+ Le critère indique **ce qui** doit être vrai, et non **comment** l'implémenter. Les balises d'applicabilité (`[all]`, `[npm]`, `[mcp]`, `[cli]`, `[desktop]`, `[vsix]`, `[container]`) évitent les situations embarrassantes dans les dépôts où certains éléments ne sont pas applicables.
57
+
58
+ ## Vue d'ensemble du contrat de gestion des erreurs
59
+
60
+ **Niveau 1 — Structure (obligatoire partout) :**
61
+
62
62
  ```json
63
63
  {
64
64
  "code": "INPUT_TEXT_EMPTY",
@@ -67,39 +67,39 @@ Le critère indique **ce qui** doit être vrai, et non **comment** l'implémente
67
67
  "retryable": false
68
68
  }
69
69
  ```
70
-
71
- **Niveau 2 — Type de base + codes de sortie (CLI/MCP/bureau) :**
72
-
73
- | Code de sortie | Signification |
74
- |-----------|---------|
75
- | 0 | OK |
76
- | 1 | Erreur utilisateur (mauvaise entrée, configuration manquante) |
77
- | 2 | Erreur d'exécution (plantage, panne du serveur) |
78
- | 3 | Succès partiel (certains éléments ont réussi) |
79
-
80
- Les codes d'erreur utilisent des préfixes spécifiques : `IO_`, `CONFIG_`, `PERM_`, `DEP_`, `RUNTIME_`, `PARTIAL_`, `INPUT_`, `STATE_`. Les codes sont stables une fois publiés.
81
-
82
- ## Implémentation de référence
83
-
84
- [mcp-voice-soundboard](https://github.com/mcp-tool-shop-org/mcp-voice-soundboard) était le premier dépôt à avoir passé Ship Gate, avec un score de **46/50** après correction des problèmes.
85
-
86
- ## Tableau de bord
87
-
88
- | Catégorie | Score | Notes |
89
- |----------|-------|-------|
90
- | A. Sécurité | 10/10 | SECURITY.md, pas de code exécutable, pas de collecte de données. |
91
- | B. Gestion des erreurs | N/A | Dépôt de normes — pas de code pour la gestion des erreurs. |
92
- | C. Documentation pour l'utilisateur | 10/10 | README, CHANGELOG, ADOPTION, tous les modèles documentés. |
93
- | D. Bonnes pratiques de déploiement | 8/10 | Pas de code à vérifier/tester, toutes les normes versionnées. |
94
- | E. Identité | 10/10 | Logo, traductions, page d'accueil, métadonnées. |
95
- | **Total** | **38/40** | B exclu (non applicable). |
96
-
97
- ## Licence
98
-
99
- [MIT](LICENSE)
100
-
70
+
71
+ **Niveau 2 — Type de base + codes de sortie (CLI/MCP/bureau) :**
72
+
73
+ | Code de sortie | Signification |
74
+ |-----------|---------|
75
+ | 0 | OK |
76
+ | 1 | Erreur utilisateur (mauvaise entrée, configuration manquante) |
77
+ | 2 | Erreur d'exécution (plantage, panne du serveur) |
78
+ | 3 | Succès partiel (certains éléments ont réussi) |
79
+
80
+ Les codes d'erreur utilisent des préfixes spécifiques : `IO_`, `CONFIG_`, `PERM_`, `DEP_`, `RUNTIME_`, `PARTIAL_`, `INPUT_`, `STATE_`. Les codes sont stables une fois publiés.
81
+
82
+ ## Implémentation de référence
83
+
84
+ [mcp-voice-soundboard](https://github.com/mcp-tool-shop-org/mcp-voice-soundboard) était le premier dépôt à avoir passé Ship Gate, avec un score de **46/50** après correction des problèmes.
85
+
86
+ ## Tableau de bord
87
+
88
+ | Catégorie | Score | Notes |
89
+ |----------|-------|-------|
90
+ | A. Sécurité | 10/10 | SECURITY.md, pas de code exécutable, pas de collecte de données. |
91
+ | B. Gestion des erreurs | N/A | Dépôt de normes — pas de code pour la gestion des erreurs. |
92
+ | C. Documentation pour l'utilisateur | 10/10 | README, CHANGELOG, ADOPTION, tous les modèles documentés. |
93
+ | D. Bonnes pratiques de déploiement | 8/10 | Pas de code à vérifier/tester, toutes les normes versionnées. |
94
+ | E. Identité | 10/10 | Logo, traductions, page d'accueil, métadonnées. |
95
+ | **Total** | **38/40** | B exclu (non applicable). |
96
+
97
+ ## Licence
98
+
99
+ [MIT](LICENSE)
100
+
101
101
  ---
102
-
102
+
103
103
  <p align="center">
104
104
  Built by <a href="https://mcp-tool-shop.github.io/">MCP Tool Shop</a>
105
105
  </p>
package/README.hi.md CHANGED
@@ -1,64 +1,64 @@
1
- <p align="center">
2
- <a href="README.ja.md">日本語</a> | <a href="README.zh.md">中文</a> | <a href="README.es.md">Español</a> | <a href="README.fr.md">Français</a> | <a href="README.md">English</a> | <a href="README.it.md">Italiano</a> | <a href="README.pt-BR.md">Português (BR)</a>
3
- </p>
4
-
1
+ <p align="center">
2
+ <a href="README.ja.md">日本語</a> | <a href="README.zh.md">中文</a> | <a href="README.es.md">Español</a> | <a href="README.fr.md">Français</a> | <a href="README.md">English</a> | <a href="README.it.md">Italiano</a> | <a href="README.pt-BR.md">Português (BR)</a>
3
+ </p>
4
+
5
5
  <p align="center">
6
6
  <img src="https://raw.githubusercontent.com/mcp-tool-shop-org/brand/main/logos/shipcheck/readme.jpg" alt="Shipcheck" width="400">
7
7
  </p>
8
-
8
+
9
9
  <p align="center">
10
10
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="MIT License"></a>
11
11
  <a href="https://mcp-tool-shop-org.github.io/shipcheck/"><img src="https://img.shields.io/badge/Landing_Page-live-blue" alt="Landing Page"></a>
12
12
  </p>
13
-
13
+
14
14
  <p align="center">
15
15
  Product standards for MCP Tool Shop.<br>
16
16
  Templates, contracts, and adoption guides that define what "done" means before anything ships.
17
17
  </p>
18
-
18
+
19
19
  ---
20
-
21
- ## क्यों?
22
-
23
- "डन" का पहले मतलब होता था कि कोड काम कर रहा है। लेकिन यह पर्याप्त नहीं है। एक उत्पाद में कोड के साथ-साथ सुरक्षा, त्रुटि प्रबंधन, दस्तावेज़, पहचान और वितरण प्रक्रिया की स्वच्छता भी शामिल होती है। "शिपचेक" इन सभी मानकों को निर्धारित करता है।
24
-
25
- ## यहां क्या है?
26
-
27
- | मानक। | यह क्या शामिल करता है। |
28
- |----------|----------------|
29
- | [Ship Gate](templates/SHIP_GATE.md) | 27 "हार्ड-गेट" और 4 "सॉफ्ट-गेट" प्री-रिलीज़ चेकलिस्ट आइटम। |
30
- | [Error Contract](contracts/error-contract.md) | दो-स्तरीय संरचित त्रुटि मानक, जिसमें कोड रजिस्ट्री शामिल है। |
31
- | [Security Baseline](templates/SECURITY.md) | रिपोर्ट ईमेल, प्रतिक्रिया देने का समय, खतरे की सीमा। |
32
- | [Handbook](templates/HANDBOOK.md) | जटिल उपकरणों के लिए परिचालन संबंधी उपयोगकर्ता पुस्तिका। |
33
- | [Scorecard](templates/SCORECARD.md) | सुधार से पहले और बाद के प्रदर्शन का मूल्यांकन। |
34
- | [Adoption Guide](ADOPTION.md) | "शिपचेक" को किसी भी रिपॉजिटरी पर 30 मिनट से कम समय में लागू करें। |
35
-
36
- ## शुरुआत कैसे करें।
37
-
38
- 1. [ADOPTION.md](ADOPTION.md) फ़ाइल पढ़ें।
39
- 2. `templates/SHIP_GATE.md` फ़ाइल को अपनी रिपॉजिटरी के रूट फ़ोल्डर में कॉपी करें।
40
- 3. लागू होने वाली चीज़ों पर टिक करें, और जो लागू नहीं होती हैं, उन्हें `SKIP:` लिखकर चिह्नित करें।
41
- 4. जब सभी आवश्यक जांच पूरी हो जाएं, तो इसे रिलीज़ करें।
42
-
43
- ## यह कैसे काम करता है।
44
-
45
- **कठोर गेट्स** (ए से डी): ये रिलीज को रोकते हैं।
46
-
47
- - **ए. सुरक्षा आधार:** SECURITY.md, खतरे का मॉडल, कोई गुप्त जानकारी नहीं, कोई डेटा संग्रह नहीं, डिफ़ॉल्ट सुरक्षा स्थिति।
48
- - **बी. त्रुटि प्रबंधन:** संरचित त्रुटि प्रारूप (कोड/संदेश/संकेत/पुनः प्रयास योग्य), सुरक्षित आउटपुट, सुचारू रूप से कार्यक्षमता में कमी।
49
- - **सी. ऑपरेटर दस्तावेज़:** README, CHANGELOG, LICENSE, उपकरण दस्तावेज़।
50
- - **डी. वितरण संबंधी स्वच्छता:** स्क्रिप्ट का सत्यापन, संस्करण का मिलान, निर्भरता स्कैनिंग, लॉकफ़ाइल।
51
-
52
- **सॉफ्ट गेट** (ई) अवरोधक नहीं है, बल्कि यह "संपूर्णता" को परिभाषित करता है।
53
-
54
- - **ई. पहचान (Identity)** — लोगो, अनुवाद, लैंडिंग पृष्ठ, रिपॉ मेटाडेटा।
55
-
56
- गेट यह बताता है कि **क्या** सत्य होना चाहिए, न कि इसे **कैसे** लागू किया जाए। "उपयोगिता" टैग (`[all]`, `[npm]`, `[mcp]`, `[cli]`, `[desktop]`, `[vsix]`, `[container]`) उन रिपॉजिटरी में "चेकबॉक्स शर्म" को रोकते हैं जहां कुछ चीजें लागू नहीं होती हैं।
57
-
58
- ## त्रुटि अनुबंध: एक संक्षिप्त विवरण।
59
-
60
- **स्तर 1 - आकार (हर जगह अनिवार्य):**
61
-
20
+
21
+ ## क्यों?
22
+
23
+ "डन" का पहले मतलब होता था कि कोड काम कर रहा है। लेकिन यह पर्याप्त नहीं है। एक उत्पाद में कोड के साथ-साथ सुरक्षा, त्रुटि प्रबंधन, दस्तावेज़, पहचान और वितरण प्रक्रिया की स्वच्छता भी शामिल होती है। "शिपचेक" इन सभी मानकों को निर्धारित करता है।
24
+
25
+ ## यहां क्या है?
26
+
27
+ | मानक। | यह क्या शामिल करता है। |
28
+ |----------|----------------|
29
+ | [Ship Gate](templates/SHIP_GATE.md) | 27 "हार्ड-गेट" और 4 "सॉफ्ट-गेट" प्री-रिलीज़ चेकलिस्ट आइटम। |
30
+ | [Error Contract](contracts/error-contract.md) | दो-स्तरीय संरचित त्रुटि मानक, जिसमें कोड रजिस्ट्री शामिल है। |
31
+ | [Security Baseline](templates/SECURITY.md) | रिपोर्ट ईमेल, प्रतिक्रिया देने का समय, खतरे की सीमा। |
32
+ | [Handbook](templates/HANDBOOK.md) | जटिल उपकरणों के लिए परिचालन संबंधी उपयोगकर्ता पुस्तिका। |
33
+ | [Scorecard](templates/SCORECARD.md) | सुधार से पहले और बाद के प्रदर्शन का मूल्यांकन। |
34
+ | [Adoption Guide](ADOPTION.md) | "शिपचेक" को किसी भी रिपॉजिटरी पर 30 मिनट से कम समय में लागू करें। |
35
+
36
+ ## शुरुआत कैसे करें।
37
+
38
+ 1. [ADOPTION.md](ADOPTION.md) फ़ाइल पढ़ें।
39
+ 2. `templates/SHIP_GATE.md` फ़ाइल को अपनी रिपॉजिटरी के रूट फ़ोल्डर में कॉपी करें।
40
+ 3. लागू होने वाली चीज़ों पर टिक करें, और जो लागू नहीं होती हैं, उन्हें `SKIP:` लिखकर चिह्नित करें।
41
+ 4. जब सभी आवश्यक जांच पूरी हो जाएं, तो इसे रिलीज़ करें।
42
+
43
+ ## यह कैसे काम करता है।
44
+
45
+ **कठोर गेट्स** (ए से डी): ये रिलीज को रोकते हैं।
46
+
47
+ - **ए. सुरक्षा आधार:** SECURITY.md, खतरे का मॉडल, कोई गुप्त जानकारी नहीं, कोई डेटा संग्रह नहीं, डिफ़ॉल्ट सुरक्षा स्थिति।
48
+ - **बी. त्रुटि प्रबंधन:** संरचित त्रुटि प्रारूप (कोड/संदेश/संकेत/पुनः प्रयास योग्य), सुरक्षित आउटपुट, सुचारू रूप से कार्यक्षमता में कमी।
49
+ - **सी. ऑपरेटर दस्तावेज़:** README, CHANGELOG, LICENSE, उपकरण दस्तावेज़।
50
+ - **डी. वितरण संबंधी स्वच्छता:** स्क्रिप्ट का सत्यापन, संस्करण का मिलान, निर्भरता स्कैनिंग, लॉकफ़ाइल।
51
+
52
+ **सॉफ्ट गेट** (ई) अवरोधक नहीं है, बल्कि यह "संपूर्णता" को परिभाषित करता है।
53
+
54
+ - **ई. पहचान (Identity)** — लोगो, अनुवाद, लैंडिंग पृष्ठ, रिपॉ मेटाडेटा।
55
+
56
+ गेट यह बताता है कि **क्या** सत्य होना चाहिए, न कि इसे **कैसे** लागू किया जाए। "उपयोगिता" टैग (`[all]`, `[npm]`, `[mcp]`, `[cli]`, `[desktop]`, `[vsix]`, `[container]`) उन रिपॉजिटरी में "चेकबॉक्स शर्म" को रोकते हैं जहां कुछ चीजें लागू नहीं होती हैं।
57
+
58
+ ## त्रुटि अनुबंध: एक संक्षिप्त विवरण।
59
+
60
+ **स्तर 1 - आकार (हर जगह अनिवार्य):**
61
+
62
62
  ```json
63
63
  {
64
64
  "code": "INPUT_TEXT_EMPTY",
@@ -67,39 +67,39 @@
67
67
  "retryable": false
68
68
  }
69
69
  ```
70
-
71
- **स्तर 2 - आधारभूत प्रकार + निकास कोड (कमांड लाइन इंटरफेस/मल्टी-प्रोटोकॉल सर्वर/डेस्कटॉप):**
72
-
73
- | निकास कोड। | अर्थ। |
74
- |-----------|---------|
75
- | 0 | OK |
76
- | 1 | उपयोगकर्ता की गलती (गलत इनपुट, कॉन्फ़िगरेशन की कमी)। |
77
- | 2 | रनटाइम त्रुटि (क्रैश, बैकएंड में खराबी)। |
78
- | 3 | आंशिक सफलता (कुछ चीजें सफल रहीं)। |
79
-
80
- त्रुटि कोडों में नामस्थान वाले उपसर्गों का उपयोग किया जाता है: `IO_`, `CONFIG_`, `PERM_`, `DEP_`, `RUNTIME_`, `PARTIAL_`, `INPUT_`, `STATE_`. एक बार जारी होने के बाद, ये कोड स्थिर रहते हैं।
81
-
82
- ## संदर्भ कार्यान्वयन।
83
-
84
- [mcp-voice-soundboard](https://github.com/mcp-tool-shop-org/mcp-voice-soundboard) यह पहला रिपॉजिटरी था जिसने "शिप गेट" की जांच पास की - सुधार के बाद इसे **46/50** अंक मिले।
85
-
86
- ## स्कोरकार्ड।
87
-
88
- | श्रेणी। | स्कोर। | टिप्पणियाँ। |
89
- |----------|-------|-------|
90
- | अ. सुरक्षा। | 10/10 | सुरक्षा.md: इसमें कोई निष्पादन योग्य कोड नहीं है, और यह कोई डेटा संग्रह नहीं करता है। |
91
- | बी. त्रुटि प्रबंधन। | लागू नहीं. | मानकों का भंडार - कोई भी त्रुटि नहीं। |
92
- | सी. ऑपरेटर दस्तावेज़। | 10/10 | README, CHANGELOG, अपनाना, सभी टेम्पलेट्स का विवरण दिया गया है। |
93
- | डी. शिपिंग स्वच्छता। | 8/10 | कोई भी कोड सत्यापन/परीक्षण के लिए उपलब्ध नहीं है, सभी मानकों को संस्करणों में विभाजित किया गया है। |
94
- | ई. पहचान। | 10/10 | लोग, अनुवाद, लैंडिंग पेज, मेटाडेटा। |
95
- | **Total** | **38/40** | बी: अप्रासंगिक (लागू नहीं)। |
96
-
97
- ## लाइसेंस।
98
-
99
- [एमआईटी] (लाइसेंस)
100
-
70
+
71
+ **स्तर 2 - आधारभूत प्रकार + निकास कोड (कमांड लाइन इंटरफेस/मल्टी-प्रोटोकॉल सर्वर/डेस्कटॉप):**
72
+
73
+ | निकास कोड। | अर्थ। |
74
+ |-----------|---------|
75
+ | 0 | OK |
76
+ | 1 | उपयोगकर्ता की गलती (गलत इनपुट, कॉन्फ़िगरेशन की कमी)। |
77
+ | 2 | रनटाइम त्रुटि (क्रैश, बैकएंड में खराबी)। |
78
+ | 3 | आंशिक सफलता (कुछ चीजें सफल रहीं)। |
79
+
80
+ त्रुटि कोडों में नामस्थान वाले उपसर्गों का उपयोग किया जाता है: `IO_`, `CONFIG_`, `PERM_`, `DEP_`, `RUNTIME_`, `PARTIAL_`, `INPUT_`, `STATE_`. एक बार जारी होने के बाद, ये कोड स्थिर रहते हैं।
81
+
82
+ ## संदर्भ कार्यान्वयन।
83
+
84
+ [mcp-voice-soundboard](https://github.com/mcp-tool-shop-org/mcp-voice-soundboard) यह पहला रिपॉजिटरी था जिसने "शिप गेट" की जांच पास की - सुधार के बाद इसे **46/50** अंक मिले।
85
+
86
+ ## स्कोरकार्ड।
87
+
88
+ | श्रेणी। | स्कोर। | टिप्पणियाँ। |
89
+ |----------|-------|-------|
90
+ | अ. सुरक्षा। | 10/10 | सुरक्षा.md: इसमें कोई निष्पादन योग्य कोड नहीं है, और यह कोई डेटा संग्रह नहीं करता है। |
91
+ | बी. त्रुटि प्रबंधन। | लागू नहीं. | मानकों का भंडार - कोई भी त्रुटि नहीं। |
92
+ | सी. ऑपरेटर दस्तावेज़। | 10/10 | README, CHANGELOG, अपनाना, सभी टेम्पलेट्स का विवरण दिया गया है। |
93
+ | डी. शिपिंग स्वच्छता। | 8/10 | कोई भी कोड सत्यापन/परीक्षण के लिए उपलब्ध नहीं है, सभी मानकों को संस्करणों में विभाजित किया गया है। |
94
+ | ई. पहचान। | 10/10 | लोग, अनुवाद, लैंडिंग पेज, मेटाडेटा। |
95
+ | **Total** | **38/40** | बी: अप्रासंगिक (लागू नहीं)। |
96
+
97
+ ## लाइसेंस।
98
+
99
+ [एमआईटी] (लाइसेंस)
100
+
101
101
  ---
102
-
102
+
103
103
  <p align="center">
104
104
  Built by <a href="https://mcp-tool-shop.github.io/">MCP Tool Shop</a>
105
105
  </p>