Documentation
Lecture seule des fichiers markdown du projet
AGENTS.md
Reverie — guide de contribution
Objectif
Reverie rassemble les services d'un serveur Minecraft Skyblock : le jeu, le site web et les interfaces qui les relient. Les changements doivent préserver la cohérence entre ces trois périmètres.
Arborescence
| Répertoire | Responsabilité |
|---|---|
minecraft/ | Serveur Paper et sa configuration applicative |
website/ | Site web et backend associé |
api/ | Surface d'échange entre les applications |
docs/ | Documentation transverse |
scripts/ | Automatisations du projet |
tools/ | Outils de maintenance ou de développement |
Principes de travail
- Lire les instructions du sous-répertoire concerné avant toute modification.
- Garder les contrats entre Minecraft, l'API et le site explicites et rétrocompatibles.
- Documenter une décision lorsqu'elle modifie un flux métier ou une interface.
- Préférer un changement petit, vérifiable et réversible.
- Faire évoluer le schéma PostgreSQL par des migrations Prisma versionnées et relues ; une migration est un changement transverse, pas un détail local.
Limites d'autorité
- Ne jamais utiliser
sudo. - Ne jamais modifier directement les fichiers système ou la configuration Nginx.
- Le site est exécuté par l'unité systemd
reverie-website; sa gestion reste hors du périmètre des modifications applicatives. - Ne jamais placer de secret, mot de passe, clé privée ou jeton dans le dépôt.
- Ne pas modifier les plugins tiers ; isoler les adaptations dans le code ou la configuration appartenant à Reverie.
Avant une intervention
Confirmer le périmètre, identifier le composant propriétaire et consulter sa documentation. Les détails d'exploitation (services, domaines, ports, sauvegardes et déploiement) doivent être ajoutés ici seulement lorsqu'ils sont vérifiés.