Add a CONTRIBUTION guide
continuous-integration/drone/push Build is failing Details

This commit is contained in:
Fred Pauchet 2021-10-04 21:23:22 +02:00
parent c28d0b4cdb
commit a78a5c2383
1 changed files with 35 additions and 0 deletions

35
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,35 @@
# Contibuer à Gwift
(Grossièrement traduit et adapté de [ProGit](https://raw.githubusercontent.com/progit/progit2/main/CONTRIBUTING.md))
## Licence
Quand vous ouvrez une *pull request*, vous acceptez d'appliquer la même licence que le projet à votre travail.
Aussi, vous acceptez de céder votre travail sous cette même licence.
Si vos modifications devaient apparaitre dans une version publiée, vous apparaitrez dans la [liste des contributeurs](book/contributors.adoc).
## Signaler un problème
Vérifiez avant tout s'il n'existe pas déjà un problème similaire, avant de créer un nouveau ticket.
Aussi, vérifiez si ce même problème n'a pas déjà été corrigé dans les fichiers sources, mais n'aurait pas encore été pris en compte dans une version ultérieure du fichier PDF.
## Petites corrections
Les errata et clarifications basiques seront acceptés si nous sommes d'accord sur le fait qu'ils améliorent le contenu.
Vous pouvez ouvrir un ticket, de manière à ce que nous discutions de la manière dont il faut adresser le changement.
Si vous n'avez jamais réalisé ceci, le [flow guide](https://guides.github.com/introduction/flow/) peut être utile au début.
## Gros changements
Ouvrez d'abord une discussion, de manière à démarrer.
Une grosse modification tend à être très subjective, et ne vise souvent qu'un petit nombre de lecteurs/utilisateurs.
## Images et schéma
Les images de ce livre sont générées en utilisant [Draw.io](draw.io).
## Traductions
Il n'y en a pas pour le moment 😉.