Copiez et adaptez le modèle de contribution
Remplacez les champs provisoires et vérifiez chaque commande et chaque lien. Continuez à accueillir les corrections de documentation et les signalements de bugs même lorsqu’une personne n’est pas prête à modifier le code de l’application.
# Contribuer
## Avant de commencer
Lisez le README et consultez les tickets existants.
Pour les changements importants, discutez de l’approche avant de l’implémenter.
## Installation locale
[Environnement d’exécution requis et commandes d’installation vérifiées]
## Signaler un bug
Indiquez la version, l’environnement, les étapes, le résultat attendu et le résultat constaté.
Retirez les secrets et données personnelles des journaux.
## Soumettre une pull request
- Expliquez le problème et le changement proposé.
- Gardez une modification ciblée.
- Exécutez [les vérifications propres au projet].
- Mettez à jour la documentation concernée.
## Relecture
[Qui relit, comment répondre et disponibilités réalistes]
## Autres façons d’aider
[Documentation, exemples, traductions ou signalements reproductibles]Rendez les consignes faciles à trouver
GitHub reconnaît les consignes de contribution à la racine du dépôt et dans les dossiers docs ou .github. Ajoutez aussi un lien dans le README pour qu’une personne lisant la présentation du projet trouve immédiatement la procédure.
Vérifiez le parcours depuis les véritables points d’entrée de contribution du dépôt. Si plusieurs fichiers de consignes existent, harmonisez les instructions contradictoires. Une personne ne devrait pas trouver une commande d’installation dans le README et une autre, différente et non prise en charge, dans le guide de contribution.
Prévoyez une première contribution accessible
Choisissez une petite tâche au résultat clair, comme corriger un exemple pour un environnement d’exécution pris en charge. Expliquez comment reproduire le problème, quel comportement doit changer et comment vérifier la résolution. Évitez de qualifier une tâche d’accessible aux débutants si elle dépend de connaissances internes non documentées.
Annoncez honnêtement vos disponibilités pour les relectures. Si vous ne pouvez pas promettre un délai de réponse, expliquez plutôt comment consulter l’avancement. Des limites claires réduisent le travail abandonné et sont plus utiles qu’une promesse de fusionner toutes les contributions.
Questions fréquentes
CONTRIBUTING.md remplace-t-il README.md ?
Non. Le README explique le projet et son utilisation. Les consignes de contribution expliquent comment proposer et vérifier des modifications.
Dois-je copier les commandes de test d’un autre projet ?
Seulement si ce sont aussi les bonnes commandes pour votre projet. Remplacez les champs provisoires par des commandes que vous avez réellement vérifiées.
Les consignes de contribution garantissent-elles davantage de contributeurs ?
Non. Elles réduisent l’incertitude pour les personnes intéressées, mais l’utilité du projet, la qualité des tâches et le suivi des responsables restent importants.