Contribuer au projet

Contribuer au projet

Lorsque vous soumettez une contribution, veuillez indiquer clairement le copyright et inclure toute mention légale relative à la licence. Notez que pour être acceptée, la contribution doit être déposée sous la même licence que le reste du document, c'est-à-dire la GPL version 3 ou ultérieure.

Les contributions au projet, comme les traductions et les correctifs, sont bienvenues. Les livraisons au dépôt sont possibles pour tout le monde, cependant, nous vous demandons d'envoyer les changements importants sur la liste de diffusion au préalable. Veuillez consulter Contacter pour plus d'informations.

Le ${project} utilise Git en tant que système de contrôle de version et de gestion du code source. Comme expliqué dans Dépôts Git il existe deux branches de développement principales: debian et debian-next. Tout le monde peut faire des livraisons aux branches debian-next des dépôts live-boot, live-build, live-config, live-images, live-manual et live-tools.

Cependant, il y a certaines restrictions. Le serveur rejette:

●  Push non fast-forward.

●  Commits merge.

●  Ajout ou suppression d'étiquettes ou des branches.

Même si toutes les livraisons pourraient être révisées, nous vous demandons d'utiliser votre bon sens et de faire bonnes livraisons avec de bons messages de livraison.

●  Veuillez écrire les commentaires de livraison à l'aide de phrases complètes, en commençant par une majuscule et en terminant par un point, et avec la forme 'Fixing/Adding/Removing/Correcting/Translating/...'.

●  Écrivez de bons messages de livraison. La première ligne doit être un résumé précis du contenu du commit qui sera inclus dans le changelog. Si vous avez besoin de faire quelques explications supplémentaires, écrivez-les au-dessous en laissant une ligne vide après la première, puis une autre ligne vide après chaque paragraphe. Les lignes des paragraphes ne doivent pas dépasser 80 caractères.

●  Faites des livraisons de façon atomique, c'est-à-dire, ne mélangez pas des choses sans liens entre elles dans la même livraison. Faites un commit différent pour chaque modification que vous apportez.

Faire des changements

Afin de faire un push sur les dépôts, vous devez suivre la procédure suivante. Ici, nous utilisons live-manual comme un exemple pour le remplacer par le nom du dépôt dans lequel vous souhaitez travailler. Pour plus d'informations sur la façon de modifier live-manual, consultez Contribuer à ce document.

●  Téléchargez la clé publique:

 $ mkdir -p ~/.ssh/keys
 $ wget http://live-systems.org/other/keys/git@live-systems.org -O ~/.ssh/keys/git@live-systems.org
 $ wget http://live-systems.org/other/keys/git@live-systems.org.pub -O ~/.ssh/keys/git@live-systems.org.pub
 $ chmod 0600 ~/.ssh/keys/git@live-systems.org*  

●  Ajoutez la section suivante à votre configuration openssh-client:

 $ cat >> ~/.ssh/config << EOF
 Host live-systems.org
     Hostname live-systems.org
     User git
     IdentitiesOnly yes
     IdentityFile ~/.ssh/keys/git@live-systems.org
 EOF  

●  Clonez live-manual avec ssh:

 $ git clone git@live-systems.org:/live-manual.git
 $ cd live-manual && git checkout debian-next  

●  Assurez-vous d'avoir renseignés les champs d'auteur et d'email dans Git:

  $ git config user.name "John Doe"
  $ git config user.email john@example.org  

Important: Rappelez-vous que vous devez livrer les changements sur la branche debian-next.

●  Effectuez vos modifications. Dans cet exemple, vous devriez commencer par écrire une nouvelle section traitant l'application des correctifs et ensuite préparer l'ajout des fichiers et écrire le message de livraison comme ceci:

 $ git commit -a -m "Adding a section on applying patches."  

●  Envoyez votre commit au serveur:

 $ git push