README complet + CONTRIBUTING.md
- README réécrit à partir du code : fonctionnalités réelles, stack, installation (dev local, build, prod), variables d'environnement documentées avec leur effet, références aux docs existants - CONTRIBUTING.md créé : signalement de bug, procédure de PR, mention que GitHub est un miroir public du dépôt Gitea source Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
# Contribuer à La Voix du Peuple
|
||||
|
||||
Merci de l'intérêt pour le projet. Ce document décrit comment signaler un problème ou proposer une contribution.
|
||||
|
||||
---
|
||||
|
||||
## Dépôts
|
||||
|
||||
Le dépôt source est hébergé sur Gitea (instance privée). GitHub est un miroir public en lecture seule. Les pull requests doivent être soumises sur le miroir GitHub — elles seront intégrées manuellement dans le dépôt source après relecture.
|
||||
|
||||
---
|
||||
|
||||
## Signaler un bug
|
||||
|
||||
Avant d'ouvrir une issue, vérifier qu'elle n'existe pas déjà.
|
||||
|
||||
Une bonne issue contient :
|
||||
- La version ou le commit concerné
|
||||
- Les étapes pour reproduire le problème
|
||||
- Le comportement observé et le comportement attendu
|
||||
- Le contexte (OS, navigateur, logs backend si disponibles)
|
||||
|
||||
Pour les failles de sécurité, ne pas ouvrir d'issue publique. Contacter directement l'auteur.
|
||||
|
||||
---
|
||||
|
||||
## Proposer une contribution
|
||||
|
||||
1. Ouvrir une issue pour discuter de la modification avant de coder, sauf pour les corrections triviales (faute d'orthographe, lien cassé).
|
||||
2. Forker le dépôt et créer une branche à partir de `main`.
|
||||
3. Respecter les conventions existantes : TypeScript strict côté frontend, Python 3.11+ côté backend, pas d'ORM, pas de dépendances superflues.
|
||||
4. Toute modification fonctionnelle doit être testable manuellement — décrire la procédure de test dans la PR.
|
||||
5. Ne pas modifier le fichier `LICENSE` ni les en-têtes de copyright.
|
||||
6. Soumettre la pull request sur le miroir GitHub avec une description claire du problème résolu et de l'approche retenue.
|
||||
|
||||
---
|
||||
|
||||
## Licence des contributions
|
||||
|
||||
En soumettant une contribution, vous acceptez qu'elle soit distribuée sous la licence EUPL-1.2, identique à celle du projet.
|
||||
Reference in New Issue
Block a user