Contribuer à la documentation

Tout comme le logiciel PrestaShop, la documentation est ouverte à tous pour des suggestions, des idées, et des modifications. Tout le monde est bienvenu, et même encouragé, à contribuer à la traduction, à la mise à jour, et à l'écriture de la documentation utilisateur 1.7.

GitBook et GitHub sont synchronisés : si vous modifiez le contenu de n'importe quelle page sur GitBook, vos modifications seront automatiquement poussées vers le repository GitHub. Inversement, les changements apportés sur GitHub seront pris en compte sur GitBook.

Par conséquent, les deux interfaces sont ouvertes à la contribution.

Gitbook est un outil permettant d'écrire de la documentation. Il fonctionne comme un éditeur de texte et est sûrement la meilleure solution si vous n'êtes pas vraiment technophile. Pour contribuer à la documentation de PrestaShop en utilisant GitBook, veuillez nous envoyer un e-mail à documentation@prestashop.com avec une petite présentation de vous-même :

Êtes-vous un marchand ? Dans quelle langue souhaitez-vous traduire, mettre à jour ou écrire la documentation ? Qu'est-ce qui vous motive à participer à ce projet ?

Le Product Content Manager vous accueillera et vous donnera accès à la documentation en tant qu'éditeur. Vous devrez alors vous connecter avec un compte Gmail, GitHub, ou GitBook. Cliquez ici pour créer un compte GitBook.

Chaque documentation est synchronisée avec un repository sur GitHub. Les deux interfaces sont ouvertes aux contributions. Cliquez sur votre langue pour visiter le repository correspondant : anglais, français, espagnol, italien, néerlandais, farsi.

Ouvrir une issue

Une idée, une suggestion ? Faites-le savoir à la communauté en soumettant une nouvelle issue ! Il s'agit d'un gestionnaire de tickets pour la documentation utilisateur et c'est le meilleur endroit pour faire une suggestion ou proposer une amélioration. Pour cela, il vous suffit d'avoir un compte GitHub.

Modifier un fichier

Cette option est particulièrement adaptée si vous êtes un utilisateur novice de GitHub.

Créez votre compte GitHub, si vous n'en avez pas déjà un.
Sélectionnez le fichier que vous souhaitez modifier.
Cliquez sur le bouton "Edit" et effectuez vos modifications dans l'éditeur.
Une fois que vous avez terminé, allez en bas de la page, entrez un nom et une description et cliquez sur "Create a new branch for this commit and start a pull request".
Enfin, cliquez sur "Propose file change". GitHub créera automatiquement une nouvelle branche et un nouveau fork sur votre propre compte GitHub, puis suggérera une pull request pour ce repository.
Une fois la pull request soumise, attendez que le Product Content Manager revienne vers vous.

Merci de ne pas merger vos changements directement sur la branche master. Il est important de créer une pull request afin que votre proposition puisse être relue au préalable.

Forker le projet

Cette option est particulièrement adaptée si vous êtes déjà habitué à GitHub.

Créez votre compte GitHub, si vous n'en avez pas déjà un.
Forkez le repository de la langue de votre choix sur votre compte GitHub.
Clonez votre fork sur votre machine locale.
Créez une branche dans votre clone local pour vos modifications.
Modifiez les fichiers dans votre branche.
Poussez la branche modifiée vers votre fork dans votre compte GitHub.
Créez une pull request pour vos modifications. Si vous avez besoin d'aide pour créer une pull request, consultez la page d'aide réalisée par GitHub.
Attendez que le Product Content Manager intègre vos modifications ou laisse un commentaire avec les ajustements possibles.

Une fois que vous avez choisi la façon de contribuer qui vous convient le mieux, vous êtes prêt à participer au projet open source PrestaShop. Merci pour votre contribution !