docs: add repository documentation
This commit is contained in:
Lethary
+70
@@ -0,0 +1,70 @@
|
||||
# Secrets et configurations locales
|
||||
.env
|
||||
.env.*
|
||||
!.env.exemple
|
||||
!.env*.example
|
||||
!.env*.exemple
|
||||
|
||||
# IDE et éditeurs
|
||||
.idea/
|
||||
.vscode/
|
||||
*.iml
|
||||
|
||||
# OS
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
# Logs et fichiers temporaires
|
||||
*.log
|
||||
*.tmp
|
||||
*.temp
|
||||
*.swp
|
||||
*.swo
|
||||
*~
|
||||
|
||||
# Archives
|
||||
*.zip
|
||||
*.tar
|
||||
*.tar.gz
|
||||
*.tgz
|
||||
*.gz
|
||||
*.rar
|
||||
*.7z
|
||||
|
||||
# Python
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
.pytest_cache/
|
||||
.mypy_cache/
|
||||
.ruff_cache/
|
||||
.tox/
|
||||
.nox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
htmlcov/
|
||||
.venv/
|
||||
venv/
|
||||
env/
|
||||
|
||||
# Node.js
|
||||
node_modules/
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
pnpm-debug.log*
|
||||
|
||||
# PHP / Composer
|
||||
vendor/
|
||||
|
||||
# Build / dist
|
||||
build/
|
||||
dist/
|
||||
coverage/
|
||||
|
||||
# Terraform
|
||||
.terraform/
|
||||
*.tfstate
|
||||
*.tfstate.*
|
||||
|
||||
# Divers outils CLI
|
||||
.cache/
|
||||
@@ -0,0 +1,90 @@
|
||||
# AGENTS.md
|
||||
|
||||
## 1. Objectif
|
||||
|
||||
Maintenir ce dépôt de scripts pour TipEdge avec des changements petits, lisibles et directement utiles.
|
||||
|
||||
Produire uniquement des modifications nécessaires au besoin demandé.
|
||||
|
||||
## 2. Principes généraux
|
||||
|
||||
- Lire les fichiers concernés avant toute modification.
|
||||
- Respecter strictement les conventions déjà présentes dans le dépôt.
|
||||
- Faire simple. Réduire la surface de changement.
|
||||
- Modifier le moins de fichiers possible.
|
||||
- Expliquer par le code, pas par de la complexité ajoutée.
|
||||
- Signaler explicitement quand une convention manque au lieu d’en inventer une.
|
||||
|
||||
## 3. Lecture obligatoire avant modification
|
||||
|
||||
- Lire en entier chaque fichier que tu modifies.
|
||||
- Lire les fichiers liés au comportement impacté.
|
||||
- Vérifier l’état Git avant tout changement.
|
||||
- Si une instruction existe déjà dans `README.md`, dans ce fichier ou dans le dépôt, l’appliquer en priorité.
|
||||
|
||||
## 4. Règles de modification
|
||||
|
||||
- Faire des changements ciblés.
|
||||
- Préserver le comportement existant sauf demande explicite.
|
||||
- Conserver les noms, structures et patterns déjà utilisés.
|
||||
- Ajouter seulement le code nécessaire au besoin.
|
||||
- Supprimer le code mort rencontré si sa suppression est sûre et locale.
|
||||
- Refuser les changements hors sujet.
|
||||
|
||||
## 5. Qualité du code
|
||||
|
||||
- Écrire du code lisible, court et testable.
|
||||
- Éviter la duplication évidente.
|
||||
- Éviter la complexité inutile, les abstractions prématurées et les couches techniques gratuites.
|
||||
- Ne pas laisser de code mort, de branche inutilisée, de variable inutile ou de commentaire trompeur.
|
||||
- Garder des messages, noms et sorties cohérents avec le reste du dépôt.
|
||||
|
||||
## 6. Cohérence architecturale
|
||||
|
||||
- Ce dépôt est actuellement minimal. Aucune architecture complexe visible n’est établie.
|
||||
- Rester sobre tant qu’une structure claire n’existe pas.
|
||||
- Si un script ou un dossier apparaît, prolonger le pattern existant au lieu d’en créer un nouveau.
|
||||
- Ne pas introduire de framework, d’outil ou d’organisation lourde sans demande explicite.
|
||||
|
||||
## 7. Sécurité Git
|
||||
|
||||
- Ne jamais faire de `commit` sans demande explicite.
|
||||
- Ne jamais faire de `push` sans demande explicite.
|
||||
- Ne jamais faire de `force push`.
|
||||
- Ne jamais réécrire l’historique.
|
||||
- Ne jamais annuler ou écraser des changements non réalisés par toi sans accord explicite.
|
||||
- Ne pas créer de branche, de tag ou de merge sans demande explicite.
|
||||
|
||||
## 8. Sécurité
|
||||
|
||||
- Ne jamais ajouter de secret, token, mot de passe ou clé privée dans le dépôt.
|
||||
- Ne jamais exposer une donnée sensible dans un script, un log ou un exemple.
|
||||
- Demander confirmation avant toute action destructive.
|
||||
- Limiter les commandes qui modifient massivement des fichiers.
|
||||
|
||||
## 9. Prise de décision
|
||||
|
||||
- Commencer par la solution la plus simple.
|
||||
- En cas d’ambiguïté, choisir l’option la moins risquée pour l’existant.
|
||||
- Si l’information manque, le signaler clairement.
|
||||
- Si plusieurs options existent, préférer celle qui minimise l’impact et la maintenance.
|
||||
|
||||
## 10. Actions interdites
|
||||
|
||||
- Ajouter du code mort.
|
||||
- Ajouter de la complexité sans besoin démontré.
|
||||
- Faire des changements hors sujet.
|
||||
- Renommer, déplacer ou restructurer largement sans raison explicite.
|
||||
- Modifier un fichier sans l’avoir lu.
|
||||
- Introduire des conventions non visibles dans le dépôt sans le signaler.
|
||||
- Mélanger refactorisation et changement fonctionnel sans nécessité claire.
|
||||
|
||||
## 11. Résultat attendu
|
||||
|
||||
Le résultat attendu est un dépôt propre, sobre et cohérent :
|
||||
|
||||
- une modification minimale
|
||||
- un comportement préservé sauf demande explicite
|
||||
- aucun changement gratuit
|
||||
- aucune action Git non demandée
|
||||
- aucune convention inventée sans signalement
|
||||
@@ -0,0 +1,60 @@
|
||||
# Script
|
||||
|
||||
## Résumé
|
||||
|
||||
Ce dépôt sert à versionner des scripts utilisés pour TipEdge.
|
||||
|
||||
À ce stade, le contenu versionné visible est minimal. Aucun script exécutable, outil de build ou suite de tests n’est présent dans le dépôt.
|
||||
|
||||
## Objectif et cas d’usage
|
||||
|
||||
- centraliser les scripts liés à TipEdge
|
||||
- suivre leur évolution dans Git
|
||||
- fournir une base simple pour ajouter ou maintenir ces scripts
|
||||
|
||||
## Technologies visibles
|
||||
|
||||
- Git
|
||||
- Gitea comme forge distante visible dans la configuration Git
|
||||
- fichier d’environnement d’exemple : [`.env.exemple`](/home/boudetk/Script/.env.exemple)
|
||||
|
||||
## Prérequis
|
||||
|
||||
Aucun prérequis technique précis n’est vérifiable dans le dépôt pour le moment.
|
||||
|
||||
## Installation
|
||||
|
||||
La seule étape vérifiable est le clonage du dépôt.
|
||||
|
||||
```bash
|
||||
git clone <url-du-depot>
|
||||
cd Script
|
||||
```
|
||||
|
||||
## Dépendances importantes
|
||||
|
||||
Aucune dépendance applicative n’est visible dans le dépôt.
|
||||
|
||||
## Configuration
|
||||
|
||||
Un fichier [`.env.exemple`](/home/boudetk/Script/.env.exemple) est présent, mais il est vide dans l’état actuel du dépôt.
|
||||
|
||||
La configuration réellement nécessaire n’est donc pas vérifiable pour le moment.
|
||||
|
||||
## Commandes utiles
|
||||
|
||||
Aucune commande de lancement, de développement, de test ou de build n’est définie dans le dépôt.
|
||||
|
||||
## Structure du projet
|
||||
|
||||
La structure visible est actuellement très simple :
|
||||
|
||||
- [README.md](/home/boudetk/Script/README.md) : documentation du dépôt
|
||||
- [AGENTS.md](/home/boudetk/Script/AGENTS.md) : règles de travail pour les agents
|
||||
- [`.env.exemple`](/home/boudetk/Script/.env.exemple) : exemple de configuration, actuellement vide
|
||||
|
||||
## Points d’attention
|
||||
|
||||
- Le dépôt ne contient pas encore de scripts versionnés visibles.
|
||||
- Aucune convention technique, stack applicative ou procédure d’exécution n’est documentée dans les fichiers présents.
|
||||
- Toute documentation plus détaillée demanderait des scripts, configurations ou consignes supplémentaires dans le dépôt.
|
||||
|
||||
Reference in New Issue
Block a user