v0.1.0-pre.064-065
This commit is contained in:
30
docs/templates/CRATE_CHANGELOG_TEMPLATE.md
vendored
Normal file
30
docs/templates/CRATE_CHANGELOG_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
<!-- file: docs/templates/CRATE_CHANGELOG_TEMPLATE.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Modèle de changelog de crate
|
||||
|
||||
# Changelog de `<nom-de-crate>`
|
||||
|
||||
## Non publié
|
||||
|
||||
### Documentation
|
||||
|
||||
- Création ou mise à jour de la documentation de crate.
|
||||
|
||||
## 0.1.0
|
||||
|
||||
### Migré
|
||||
|
||||
- Migration depuis les composants correspondants de `khadhroony-bot2` vers l’architecture consolidée de `khadhroony-bot3`.
|
||||
|
||||
### Modifié
|
||||
|
||||
- Adoption des règles Rust et Khadhroony applicables à bot3.
|
||||
|
||||
### Validation
|
||||
|
||||
- Indiquer uniquement les validations réellement exécutées et pertinentes pour cette crate.
|
||||
|
||||
### Limitations connues
|
||||
|
||||
- Indiquer les fonctionnalités partielles, non raccordées ou non validées.
|
||||
36
docs/templates/CRATE_README_TEMPLATE.md
vendored
Normal file
36
docs/templates/CRATE_README_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,36 @@
|
||||
<!-- file: docs/templates/CRATE_README_TEMPLATE.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Modèle de README de crate
|
||||
|
||||
> Ce modèle est une aide de rédaction. Supprimer les instructions et sections non applicables après analyse réelle de la crate.
|
||||
|
||||
# `<nom-de-crate>`
|
||||
|
||||
## Objectif
|
||||
|
||||
## Périmètre
|
||||
|
||||
## Responsabilités
|
||||
|
||||
## Hors périmètre
|
||||
|
||||
## Fonctionnalités disponibles
|
||||
|
||||
## Surface publique principale
|
||||
|
||||
Présenter les catégories d’API ou façades sans recopier `USAGE.md`.
|
||||
|
||||
## Binaire(s)
|
||||
|
||||
Supprimer cette section si la crate ne fournit aucun binaire.
|
||||
|
||||
## Relations avec le workspace
|
||||
|
||||
## Statut et limites
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Guide d’utilisation](USAGE.md)
|
||||
- [Travaux restant à réaliser](TODO.md)
|
||||
- [Historique des changements](CHANGELOG.md)
|
||||
24
docs/templates/CRATE_TODO_TEMPLATE.md
vendored
Normal file
24
docs/templates/CRATE_TODO_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
<!-- file: docs/templates/CRATE_TODO_TEMPLATE.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Modèle de TODO de crate
|
||||
|
||||
# Travaux restant pour `<nom-de-crate>`
|
||||
|
||||
## Fonctionnalités manquantes
|
||||
|
||||
## Dette technique
|
||||
|
||||
## Tests manquants
|
||||
|
||||
## Validations Devnet/Mainnet manquantes
|
||||
|
||||
## Documentation manquante
|
||||
|
||||
## Dépendances ou contraintes externes
|
||||
|
||||
## Éléments confirmés mais reportés
|
||||
|
||||
## Hors périmètre
|
||||
|
||||
> Ne reprendre une idée de `docs/IDEA_REMINDERS.md` qu’après confirmation, attribution à cette crate et reformulation en tâche vérifiable.
|
||||
46
docs/templates/CRATE_USAGE_TEMPLATE.md
vendored
Normal file
46
docs/templates/CRATE_USAGE_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
<!-- file: docs/templates/CRATE_USAGE_TEMPLATE.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Modèle de guide d’utilisation de crate
|
||||
|
||||
> Documenter uniquement la surface publique réellement accessible aux consommateurs.
|
||||
|
||||
# Utilisation de `<nom-de-crate>`
|
||||
|
||||
## Objectif
|
||||
|
||||
## Prérequis
|
||||
|
||||
## Dépendance et features
|
||||
|
||||
## Configuration
|
||||
|
||||
## Vue d’ensemble de l’API publique
|
||||
|
||||
## APIs publiques significatives
|
||||
|
||||
Pour chaque API ou groupe cohérent :
|
||||
|
||||
- chemin public ;
|
||||
- rôle ;
|
||||
- paramètres ou types associés ;
|
||||
- valeur retournée ;
|
||||
- erreurs ;
|
||||
- invariants ;
|
||||
- exemple.
|
||||
|
||||
## Types publics importants
|
||||
|
||||
## Erreurs et invariants
|
||||
|
||||
## Exemples
|
||||
|
||||
## Utilisation du binaire
|
||||
|
||||
Supprimer cette section si aucun binaire public n’existe.
|
||||
|
||||
## Limites connues
|
||||
|
||||
## Références
|
||||
|
||||
Lier les tests, exemples, fixtures et matrices canoniques sans les dupliquer.
|
||||
Reference in New Issue
Block a user