diff --git a/.markdownlint.json b/.markdownlint.json index 4335f3c..56e5c35 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -5,6 +5,9 @@ "tables": false, "headings": false }, + "MD007": { + "indent": 2 + }, "MD024": { "siblings_only": true } diff --git a/CHANGELOG.md b/CHANGELOG.md index bb3d396..f9881ad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,40 +8,45 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ## [Unreleased] ### Added + - Nouveaux agents: Qualité technique, Déploiement (AGENTS.md) - Documentation de déploiement `docs/DEPLOYMENT.md` - Documentation `docs/SSH_UPDATE.md` pour scripts SSH - Job CI `deployment-checks` et intégration au `release-guard` - Scripts agents activables sans Cursor (`scripts/agents/*`), doc `docs/AGENTS_RUNTIME.md`, jobs CI `agents-smoke` et `openia-agents` - - Support multi‑langages pour les agents (Shell bash/Pwsh, Node.js/TS, Go, Rust, Python) - - Nouvelle signature `scripts/agents/run.sh [target_dir] [output_dir] [agent]` et wrapper Windows `run.ps1` - - Séparation documentaire: `docs/templates/**` (squelettes) et `docs/project/**` (docs du template) - - Standards: `docs/QUALITY_STANDARDS.md`, `docs/OPEN_SOURCE_GUIDE.md` - - Fallback PowerShell pour tous les agents (`scripts/agents/run.ps1`) et normalisation: bash recommandé, PS en secours - - CI: contrôle `bash-required` et prérequis `scripts/agents/run.sh` avant release-guard - - CI: job `markdownlint` pour contrôler les lints Markdown (MD013/MD024/MD036) - - CI: job `release-create` pour publier une release via l’API Gitea (secret `RELEASE_TOKEN`) - - Script de déploiement: `scripts/deploy/setup.sh` (provisionnement `~/.4nk_template/.env` sécurisé) - - Déploiement: copie étendue (.cursor, AGENTS.md, LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, TEMPLATE_VERSION, .markdownlint.json, .cursorignore, .gitignore, security/, scripts/) +- Support multi‑langages pour les agents (Shell bash/Pwsh, Node.js/TS, Go, Rust, Python) +- Nouvelle signature `scripts/agents/run.sh [target_dir] [output_dir] [agent]` et wrapper Windows `run.ps1` +- Séparation documentaire: `docs/templates/**` (squelettes) et `docs/project/**` (docs du template) +- Standards: `docs/QUALITY_STANDARDS.md`, `docs/OPEN_SOURCE_GUIDE.md` +- Fallback PowerShell pour tous les agents (`scripts/agents/run.ps1`) et normalisation: bash recommandé, PS en secours +- CI: contrôle `bash-required` et prérequis `scripts/agents/run.sh` avant release-guard +- CI: job `markdownlint` pour contrôler les lints Markdown (MD013/MD024/MD036) +- CI: job `release-create` pour publier une release via l’API Gitea (secret `RELEASE_TOKEN`) +- Script de déploiement: `scripts/deploy/setup.sh` (provisionnement `~/.4nk_template/.env` sécurisé) +- Déploiement: copie étendue (.cursor, AGENTS.md, LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, SECURITY.md, TEMPLATE_VERSION, .markdownlint.json, .cursorignore, .gitignore, security/, scripts/) ### Changed - - Documentation projet réécrite à partir des modèles `docs/templates/**` (générique, non applicative) + +- Documentation projet réécrite à partir des modèles `docs/templates/**` (générique, non applicative) - `docs/INDEX.md` mis à jour (liens Déploiement et SSH) - Alignement documentaire sur 4NK_template (titres, liens Gitea, wording) dans docs/** - Raccourcissement guides: `docs/SECURITY_AUDIT.md`, `docs/RELEASE_PLAN.md`, `docs/ROADMAP.md` (versions génériques concises) - - CI: déclenchement sur tags `v*` pour la publication de release +- CI: déclenchement sur tags `v*` pour la publication de release ## [2025.08] - 2025-08-27 ### Added + - Garde de release (règle Cursor + scripts) imposant tests/doc/build/cohérence version/changelog/tag ### Changed + - CI Gitea: ajout du job `release-guard` (contrôles pré‑push/tag) ### Fixed ### Added (suite) + - Infrastructure de tests complète avec organisation par catégorie - Scripts d'exécution automatisés pour les tests - Documentation technique complète (Architecture, API) @@ -50,12 +55,14 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm - Garde de release (Cursor rule + scripts) imposant tests/doc/build/cohérence version/changelog/tag ### Changed (suite) + - Réorganisation complète de la structure des tests - Amélioration de la documentation avec guides détaillés - Optimisation des scripts de démarrage et redémarrage - CI Gitea: ajout d’un job release-guard (contrôles pré‑push/tag) ### Fixed (suite) + - Correction des problèmes de connectivité entre services - Amélioration de la gestion des erreurs dans les tests - Correction des configurations Docker @@ -63,6 +70,7 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ## [1.0.0] - 2024-12-19 ### Added + - Infrastructure Docker complète pour 4NK Node - Support des paiements silencieux (Silent Payments) Bitcoin - Nœud Bitcoin Core configuré en mode signet @@ -78,6 +86,7 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm - Documentation complète en français ### Features + - **Bitcoin Core** : Nœud signet avec RPC et ZMQ - **Blindbit** : Service de filtres pour les paiements silencieux - **SDK Relay** : Relais avec interface WebSocket et synchronisation mesh @@ -87,6 +96,7 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm - **Tests** : Suite de tests complète ### Technical + - Architecture Docker avec orchestration via Docker Compose - Réseau privé `btcnet` pour la communication inter-services - Volumes persistants pour les données @@ -97,134 +107,159 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ## [0.9.0] - 2024-12-15 ### Added + - Version initiale de l'infrastructure - Configuration de base des services - Tests de connectivité simples - Documentation de base ### Changed + - Configuration initiale des services Docker - Premiers tests d'intégration ### Fixed + - Problèmes de connectivité initiale - Configuration des ports et réseaux ## [0.8.0] - 2024-12-10 ### Added + - Support de la synchronisation entre relais - Implémentation du cache de déduplication - Types de messages de synchronisation - Gestionnaire de synchronisation (SyncManager) ### Changed + - Amélioration de l'architecture de synchronisation - Optimisation des performances de synchronisation ### Fixed + - Correction des problèmes de synchronisation - Amélioration de la stabilité des connexions mesh ## [0.7.0] - 2024-12-05 ### Added + - Support des paiements silencieux - Intégration avec le service Blindbit - Tests de paiements silencieux - Documentation des APIs ### Changed + - Amélioration de l'intégration Bitcoin Core - Optimisation du scan des blocs ### Fixed + - Correction des problèmes de détection des paiements - Amélioration de la performance du scan ## [0.6.0] - 2024-11-30 ### Added + - Interface WebSocket pour SDK Relay - Support des messages temps réel - Tests WebSocket - Documentation de l'API WebSocket ### Changed + - Amélioration de l'interface WebSocket - Optimisation des performances de communication ### Fixed + - Correction des problèmes de connexion WebSocket - Amélioration de la gestion des erreurs ## [0.5.0] - 2024-11-25 ### Added + - Support de Tor pour l'anonymat - Configuration du proxy Tor - Tests de connectivité Tor - Documentation de la configuration Tor ### Changed + - Amélioration de la configuration réseau - Optimisation de la connectivité anonyme ### Fixed + - Correction des problèmes de connectivité Tor - Amélioration de la stabilité du proxy ## [0.4.0] - 2024-11-20 ### Added + - Configuration multi-relais - Support de 3 instances SDK Relay - Tests multi-relais - Documentation de la configuration multi-relais ### Changed + - Amélioration de l'orchestration Docker - Optimisation de la configuration multi-relais ### Fixed + - Correction des problèmes de configuration multi-relais - Amélioration de la stabilité des instances multiples ## [0.3.0] - 2024-11-15 ### Added + - Healthchecks pour tous les services - Scripts de monitoring - Tests de santé des services - Documentation des healthchecks ### Changed + - Amélioration de la surveillance des services - Optimisation des healthchecks ### Fixed + - Correction des problèmes de healthchecks - Amélioration de la détection des problèmes ## [0.2.0] - 2024-11-10 ### Added + - Service Blindbit - Intégration avec Bitcoin Core - Tests d'intégration Blindbit - Documentation du service Blindbit ### Changed + - Amélioration de l'intégration des services - Optimisation de la communication inter-services ### Fixed + - Correction des problèmes d'intégration - Amélioration de la stabilité des services ## [0.1.0] - 2024-11-05 ### Added + - Infrastructure Docker de base - Service Bitcoin Core - Configuration de base @@ -232,10 +267,12 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm - Documentation initiale ### Changed + - Configuration initiale des services - Premiers tests d'intégration ### Fixed + - Problèmes de configuration initiale - Correction des problèmes de connectivité de base diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9bcb8ee..005ae7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -247,7 +247,7 @@ Description de ce qui se passe actuellement. ## Logs -``` +```text Logs pertinents ici ``` @@ -258,7 +258,6 @@ Si applicable, ajoutez une capture d'écran. ## Contexte Supplémentaire Toute autre information pertinente. -``` ## 💡 Proposer une Fonctionnalité @@ -288,7 +287,6 @@ Impact sur les utilisateurs et l'architecture. ## Exemples d'Utilisation Comment cette fonctionnalité serait-elle utilisée ? -``` ## 🔍 Code Review diff --git a/docs/project/CONFIGURATION.md b/docs/project/CONFIGURATION.md index af6217c..1bae7e3 100644 --- a/docs/project/CONFIGURATION.md +++ b/docs/project/CONFIGURATION.md @@ -4,8 +4,8 @@ - Secrets CI uniquement (pas de secrets en clair) - Variables agents : OPENAI_API_KEY, OPENAI_MODEL, OPENAI_API_BASE, OPENAI_TEMPERATURE - - Secret release: RELEASE_TOKEN (publication des releases via l’API Gitea) - - Variable optionnelle: GITEA_BASE_URL (ex: `https://git.4nkweb.com`) +- Secret release: RELEASE_TOKEN (publication des releases via l’API Gitea) +- Variable optionnelle: GITEA_BASE_URL (ex: `https://git.4nkweb.com`) ## Conventions diff --git a/docs/project/DEPLOYMENT.md b/docs/project/DEPLOYMENT.md index 90b7008..a419501 100644 --- a/docs/project/DEPLOYMENT.md +++ b/docs/project/DEPLOYMENT.md @@ -1,13 +1,16 @@ # Déploiement — 4NK_template (projet) ## Environnements + - Dev, staging, prod (à définir par projets consommateurs) ## Prérequis + - Outils de déploiement et conteneurisation selon projet - Secrets fournis via CI (jamais en clair) ## Processus + - Pré‑checks: tests/doc/sécurité/version/changelog/tag - Déploiement: pipeline CI dédié - Validation: smoke checks, santé, métriques @@ -36,9 +39,11 @@ bash scripts/deploy/setup.sh git@host:org/mon-projet.git --dest ~/work --force ``` ## Rollback + - Version précédente prête, compatibilité des données - Critères d’activation, procédure documentée ## Post‑déploiement + - Vérification santé/logs/dashboards - Suivi des erreurs et retours