Comme la plupart des grands projets open source que vous trouverez, la documenation est hébergé sur GitHub (le site où vous êtes normalement). Si vous avez déjà contribué à un autre projet, vous connaissez déjà ce processus et pouvez passer directement à la section suivante.
Pour ceux qui débutent en matière de collaboration via Git, voici deux étapes faciles pour vous aider à démarrer.
Avant toute chose, faites un fork du "repo" de la documentation en cliquant sur le bouton Fork en haut à droite.
Cela est nécessaire car tous le monde n'a pas accès au droit. Le fork permet d'effectuer vos changements afin ensuite d'ouvrir un pull request pour proposer vos changements afin que nous puissions en discuter.
Après avoir effectué un fork du repo principale, c'est le moment de copier celui-ci en local. Pour cela vous devez le cloner sur votre machine en local.
Pour cela, ouvrez le terminal Git bash dans le dossier où vous souhaitez cloner votre fork, ensuite tapez cette commande https://github.com/<User>/Forge-Doc
(en remplaçant par votre nom d'utilisateur github).
Une fois ceci fait, il faut désormais installer les dépendances. Pour cela ouvrez le dossier où se situent les sources de la documentation avec votre IDE (Php Storm, Webstorm, Visual Studio Code, etc...) et exécutez la commande npm install
dans le terminal associé.
Une fois les modifications effectuées, vous pouvez voir ce que cela rend en exécutant la commande npm start
dans votre terminal. Une fois le site build, une fenêtre sera lancée dans votre navigateur par défaut.
Une fois les changements testés et terminés, il est temps de faire un PR pour nous proposer vos changements. Pour cela vous devrez ouvrir un PR (en vous rendant sur cette page) et en sélectionnant votre répo (qui correspond au fork) ainsi que la branche où vous aurez effectué vos changements (il est conseillé de faire des modifications sur différentes branches pour ainsi pouvoir travailler sur plusieurs aspects le temps que vos PR soient acceptés et ne pas rester bloquer).