Faire votre premier PR (Pull Request)

Cette description est juste pour l’édition de la documentation en anglais. Toutes les nouvelles informations doivent être ajoutées d’abord en Anglais. Si vous voulez traduire la documentation dans d’autres langues (merci), utilisez crowdin.

Pour savoir comment formater le texte (titre, gras ...) et définir les liens, reportez-vous à la section “Syntaxe de code” de cette page.

Généralités

Pour toute question, commentaires ou idées nouvelles, vous pouvez contacter l’équipe de documentation par e-mail (wiki@androidaps.org). Faire un PR n’est pas difficile, mais nous pouvons vous aider à éditer la documentation.

À un moment donné, on vous suggère de faire un PR. PR est l’acronyme de Pull Request, et c’est une façon d’ajouter ou de modifier des informations enregistrées dans GitHub. En fait, ce n’est pas si difficile à faire et c’est une excellente façon de contribuer. Cette documentation est ici parce que les gens comme vous ont fait des PRs. Ne craignez pas de vous tromper ou d’éditer les mauvais documents. Il y a toujours un processus de vérification avant que les modifications ne soient fusionnées dans le référentiel “formel” de la documentation AndroidAPS. Vous ne pouvez pas endommager les originaux si vous faites des erreurs lors du processus de PR. Le processus général est :

  • Apportez des modifications au code ou à la documentation en modifiant le contenu existant.
  • Vérifiez deux fois que vos modifications vous semblent bonnes.
  • Prenez quelques notes sur ce qui a changé afin que les personnes puissent comprendre les modifications.
  • Créer un Pull Request, qui demande aux administrateurs d’utiliser vos modifications.
  • Ils feront une vérification et soit (1) ils fusionneront vos modifications, (2) ils vous feront un retour au sujet de vos modifications, ou (3) ils commenceront un nouveau document avec vos modifications.

(Remarque : Si vous êtes un apprenant visuel, il y a une vidéo YouTube ici montrant le flux de travail PR.)

Pour notre exemple, nous allons faire une modification à AndroidAPSdocs. Cela ne doit PAS être fait dans l’environnement linux de votre plateforme. Cela peut être fait sur n’importe quel PC Windows, Mac, etc. (n’importe quel ordinateur avec un accès à Internet).

  1. Accédez à https://github.com/openaps/AndroidAPSdocs et appuyez sur Fork en haut à droite pour faire votre propre copie du référentiel.

Fork repo

  1. Accédez à http://androidaps.readthedocs.io/en/latest/Getting-Started/Safety-first.html ou autre et accédez à la page que vous souhaitez éditer. Cliquez sur la boîte noire en bas à gauche de la page avec le mot vert “v: latest” ou similaire. Dans la fenêtre pop up qui apparaît, cliquez sur le mot “edit” pour éditer dans GitHub.

éditer un document

 Ou vous pouvez cliquer sur le lien "Edit in Github" dans le coin supérieur droit, puis cliquer sur l'icône en forme de crayon qui apparaît dans la barre supérieure de la page à éditer.

RTD io

  1. L’une ou l’autre des options de l’étape 2 créera une nouvelle branche dans le référentiel où vos modifications seront enregistrées. Effectuez vos modifications dans le fichier.

Notez que nous utilisons différentes extensions de fichiers : .rst (ReStructuredText) et .md (Markdown) et la syntaxe varie un peu entre les deux. Prenez soin d’utiliser la bonne syntaxe décrite ci-dessous.

Éditer la branche

  1. Vous avez travaillé dans l’onglet “<>Edit file”. Sélectionnez l’onglet “Preview changes” pour afficher une prévisualisation de votre page et vérifier que tous vos changements sont comme vous le vouliez. Si vous voyez que c’est perfectible, revenez à l’onglet d’édition pour faire vos améliorations.

mode de prévisualisation

  1. Une fois vos modifications terminées, faites défiler jusqu’au bas de la page. Dans la zone du bas, indiquez vos commentaires dans le champ texte qui indique “Add an optional extended description...”. Le titre par défaut est le nom de fichier. Essayez d’inclure une phrase expliquant la raison du la modification. Indiquer la raison permet d’aider les valideurs à comprendre ce que vous essayez de faire avec le PR.

commit commentaires

  1. Cliquez sur le bouton vert “Propose file changes” ou “Commit changes”. Dans la page qui s’affiche, cliquez sur “Create Pull Request” et de nouveau dans la page suivante, cliquez sur “Create Pull Request”.

créer un pull request

  1. Cela termine l’ouverture d’un Pull Request, PR. GitHub affecte au PR un numéro, situé après le titre et un caratère dièse. Retournez sur cette page pour vérifier si vous avez un retour (ou si vous avez des notifications Github envoyées par email, vous recevrez des emails vous indiquant toutes activités sur le PR). La modification sera maintenant dans une liste de PR que l’équipe de documentation va examiner et elle vous fera éventuellement des commentaires avant de l’intégrer dans la documentation principale d’AndroidAPS ! Si vous voulez vérifier l’avancement du PR, vous pouvez cliquer sur le logo de la cloche dans le coin supérieur droit de votre compte GitHub pour voir toutes vos notifications.

Suivi des PR

PS : Votre fork et votre branche seront toujours dans votre propre compte GitHub. Après avoir reçu une notification indiquant que votre PR avait été fusionné, vous pouvez supprimer votre branche si vous en avez terminé (la zone de notification de l’étape 8 fournira un lien pour supprimer la branche une fois qu’elle a été fermée ou fusionnée). Pour les modifications ultérieures, si vous suivez cette procédure, les éditions débuteront toujours par une version mise à jour des documents AndroidAPSdocs. Si vous choisissez d’utiliser une autre méthode pour faire une demande de PR (par ex. en partant de la branche master de dossier local comme point de départ), vous devez vous assurer que votre dossier fork est à jour en effectuant une “comparaison” en premier et en fusionnent dans toutes les mises à jour qui ont été faite depuis que vous avez mis à jour votre fork. Comme les gens ont tendance à oublier de mettre à jour leur fork, nous recommandons d’utiliser la procédure décrite ci-dessus pour faire vos PR jusqu’à ce que vous vous familiarisiez avec les exécutions des “comparaisons”.

Syntaxe du Code

Pour le moment, il y a deux langages utilisés pour les pages de documents :

  • Markdown (.md) - le langage utilisé à l’origine pour les pages de documentation
  • reStructuredText (.rst) - le nouveau langage utilisé

Nous allons changer toutes les pages de documentation de Markdown à reStructuredText peu à peu. En attendant, il est important que vous utilisez la syntaxe correcte lors de la mise en forme du texte ou des liens. Si vous n’êtes pas sûr, regardez juste le code des formats/liens sur les pages existantes.

Taille des images

Si vous utilisez des images, veuillez utiliser des tailles raisonnables. Les images de capture d’écran doivent être de 250 pixels de largeur.

Fichiers .md

Formatage du texte

  • gras : **text**
  • italique : *text*
  • Titre 1 : # headline
  • Titre 2 : ## headline
  • Titre 3 : ### headline

Images

  • images : ![alt text](../images/file.png)

Liens

  • lien externe : [alt text](www.url.tld)
  • lien interne vers une page .md : [texte alternatif](.../folder/file.md)
  • lien interne vers une page .rst : [texte alternatif](.../folder/file.rst)
  • lien interne vers un titre : [texte alternatif](.../folder/file#titre)

Fichiers .rst

Formatage du texte

  • gras : **text**

  • italique : *text*

  • Titre 1 :

    titre*****

  • Titre 2 :

    titre=====

  • Titre 3 :

    titre-----

Images

  • images:

    .. image:: ../images/modules.png:alt: texte alternatif

Liens

  • lien externe : `texte alternatif <www.url.tld>_`
  • lien interne vers une page .md : `texte alternatif <../folder/file.html>_`
  • lien interne vers une page .rst : `texte alternatif <../folder/file.html>_`
  • lien interne vers un titre : `texte alternatif <../folder/file.html#titre>_`

Liens internes

Si vous voulez définir un lien interne dans la documentation AndroidAPS, n’utilisez que liens relatifs. C’est la seule façon d’avoir un lien qui marche également dans toutes les autres langues (Chèque, Allemand...).

Dans les fichiers se terminant par .md :

  • [texte](../Usage/Test.md) va définir un lien hypertexte interne un répertoire au dessus de celui où vous êtes puis dans le sous-répertoire /Usage. La fin du fichier cible doit être .md ou .rst (pas .html)
  • [texte](./Usage/Test.md) va définir un lien hypertexte de là où vous êtes dans le sous-répertoire /Usage. La fin du fichier cible doit être .md ou .rst (pas .html)
  • Pour définir un lien vers une ancre (par ex. un titre) vous devez omettre l’extension du fichier
    • [texte](../Usage/Test#ancre) au lieu de [texte](../Usage/Test.md#ancre)

Dans les fichiers se terminant par .rst :

  • `Texte <../Usage/Test.hmtl>`_ va définir un lien hypertexte un répertoire au dessus de celui où vous êtes puis dans le sous-répertoire /Usage. L’extension du fichier cible doit être .html.

    Sauf si vous êtes dans un toctree. Dans ce cas vous devez l’écrire comme ceci : Texte <../Usage/Test.md> avec .md ou .rst (pas .html).

  • Texte <./Usage/Test.md> va définir un lien hypertexte de là où vous êtes dans le sous-répertoire /Usage.

  • Pour définir un lien vers une ancre (par ex. un titre) vous devez ajouter l’ancre au lien

    • [texte](../Usage/Test.html#ancre) au lieu de [texte](../Usage/Test#ancre)

Ajout de plusieurs images à la documentation

Si vous prévoyez de faire beaucoup de modifications, y compris d’ajouter des images pour illustrer certaines parties de la documentation (merci !), vous pouvez adopter l’approche suivante :

  • Au fur et à mesure que vous enregistrez des captures d’écran, renommez les avec un nom descriptif, mais n’utilisez pas d’espaces car Github n’aime pas cela. Utilisez à la place des underscores. Par ex. Exemple_lots_images_upload.png au lieu de “Exemple lots images upload.png”.

  • Veuillez utiliser des tailles raisonnables. Les images de capture d’écran doivent être de 250 pixels de largeur.

  • Vous pouvez télécharger des images par lots facilement en :

    1. Naviguez jusqu’au dossier images (https://github.com/openaps/AndroidAPSdocs/tree/master/docs/EN/images - mais vérifiez que vous êtes bien dans votre fork/copie du dossier Images de la documentation pour pouvoir faire ceci (remplacez “openaps” dans l’URL par votre nom d’utilisateur github)).
    2. Cliquez dans le coin supérieur droit là ou c’est écrit “Upload files”
    3. Glissez et déposez vos images dans la fenêtre
    4. Faitez un Commit de cela dans votre branche
    5. Vous pouvez maintenant rechercher le chemin d’accès URL/relatif de chaque fichier et l’utiliser en référence pour ajouter les images dans une page de la documentation.
    6. Pour voir des exemples sur la façon d’ajouter des images, vous pouvez regarder le code “brut” d’une page qui contient déjà des images intégrées avec succès. Assurez-vous d’utiliser le code correct pour la page sur laquelle vous êtes (.md or .rst). L’essentiel est d’avoir une description en texte clair, suivie d’un lien avec un chemin relatif vers l’image, comme ceci :
    • Pour les pages .md : ![Exemple de téléchargement d'images par lots](../images/Example_batch_images_upload.png) (Ce code est exactement la façon dont l’image ci-dessous est intégrée pour être affichée.)
    • Pour les pages .rst : .. image:: ../images/Example_batch_images_upload.png:alt: Exemple de téléchargement d'images par lots

Exemple de téléchargement d'images par lots

  1. Après avoir ajouté des images ou effectué des modifications, vous pouvez soumettre un PR à la branche principale d’AndroidAPSdocs.