Add contribution guide

This commit is contained in:
yannk 2016-11-14 21:41:53 +00:00
parent a49e498816
commit 731608a0cf

21
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,21 @@
#khanat-sound-source
Résumé de https://khaganat.net/wikhan/fr:collabo_khanat-sound-source
## Comment contribuer
Ce dépôt sert à gérer les contributions qui permettent de créer les .wav qui prendront place dans les samplebanks du système de jeu de Khaganat.
Il est organisé par dossier, chaque dossier est numéroté en fonction de l'Issue à laquelle il répond, avec un nom descriptif. À l'intérieur de chacun de ces dossiers, il suffit d'avoir un répertoire /_final pour les .wav destinés au système de jeu et un autre /work pour les fichiers qui on servi à les créer. À l'intérieur de ces deux répertoires, on peut organiser comme on veut.
Tant que le travail est en cours, accoler le suffixe _wip à son répertoire principal. Lorsque le travail est terminé, le dernier commit doit ôter ce suffixe.
Les fichiers .wav dans le répertoire /_final doivent impérativement :
- être en .wav
- être en 16-bits PCM
- avoir un nombre pair d'échantillons
Si vous n'avez pas les droits de commiter directement, vous devez passer par un dépôt qui forke celui-ci puis faire un merge-request lorsque vous pensez avoir terminé de répondre à une issue, pour voir votre contenu intégré.
Si vous avez directement accès au dépôt principal, il faut créer une branche feature/IssueXXX_Nom_de_la_feature qui reprenne le numéro de l'Issue à laquelle cette branche va répondre. Une fois votre travail achevé, il vous faudra également faire un merge-request sur Master.