Comment contribuer
Le contenu du glossaire Cloud Native est stocké dans ce repos Github où vous trouverez une liste d’issues,PRs, et discussions à propos du glossaire.
Vous pouvez contribuer de 4 façons :
- Travailler sur une issue existante
- Proposer un nouveau termes
- En mettre à jour un existant
- Aider à traduire le glossaire
Rejoindre la communauté du glossaire !
Envisager de rejoindre la réunion mensuelle du groupe de travail du glossaire si vous souhaitez contribuer de manière régulière. Les détails de la réunion peuvent être trouvés dans le calendrier de la CNCF. Vous pouvez aussi entrer en contact avec les mainteneurs et les contributeurs de notre #glossary sur le Slack de la CNCF - Nous aimerions beaucoup vous rencontrer!
Travailler sur une issue existante
Aller sur Glossary GitHub repo issues. Ici, vous trouverez une liste de toutes les issues. Vous pouvez les filtrer par label (e.g. English language, help needed, good first issue).
Un compte Github sera nécessaire.
Faites en sorte qu’un terme qui vous intéresse ne soit pas déjà attribué à quelqu’un d’autre. Ici, vous pourrez voir que les 3 premiers termes disponibles alors que le suivant est déjà attribué.
Une fois que vous avez trouvé le terme sur lequel vous voulez travailler, dites-le dans l’issue. Cliquez dessus et rajouter un commentaire.
Additionnellement, merci de rejoindre le channel Slack #glossary et de faire savoir aux mainteneurs que vous avez créé une issue pour un terme (idéalement, en mentionnant, @Catherine Paganini, @jmo, @Seokho Son, @Jihoon Seo, et/ou @iamnoah pour être sûr qu’il ne passe pas à côté).
Vous pouvez uniquement proposer un terme à la fois.
Si vous voulez travailler sur plusieurs termes, merci d’en finir un avant d’en proposer un nouveau.
Une fois qu’il vous a été assigné, vous pouvez commencer à travailler dessus. Pour les étapes suivantes, merci de prendre connaissance de la section Proposer un nouveau terme (créer une PR).
Proposer un nouveau terme
Vous pouvez proposer un nouveau terme à la communauté ou créer vous-même la définition de ce terme. Dans les deux cas, vous commencerez par créer une issue. Il est à noter que les termes doivent être en accord avec le CNCF’s Cloud Native definition. Les seules exceptions sont les termes fondamentaux nécessaires pour comprendre les concepts Cloud Native.
Ci-après, un guide étape par étape pour ceux et celles qui ne sont pas familier avec Github Si vous avez un compte GitHub Pro, merci de vérifier que vous utilisez nos modèles d’issue, une convention de nommage appropriée, réclamé une PR sur Slack (autrement on pourrait l’avoir raté), et où trouver les modèles de fichier. Et merci de lire le Style Guide avant de commencer - Merci!
Créer une issue
Aller sur les issues du repos Glossary et cliquer sur “New issue”.
Vous verrez plusieurs modèles. Pour proposer un nouveau terme en Français sélectionner “Request to add a new term (Optional:Non-English)”.
Ajouter le mot que vous suggérez, répondez aux deux questions d’en dessous, cocher la case et cliquer sur “Submit new issue”. Si vous souhaitez juste proposer un nouveau terme, vous pouvez vous arrêter là! Pour travailler dessus suivez les étapes d’après.
Catégoriser votre issue
Ensuite, les mainteneurs vont catégoriser le ticket. Cela veut dire qu’ils vont évaluer si votre terme peut être présent dans le glossaire (Il est à noter, que tous les termes ne sont pas admis. Les termes doivent faire partie des termes couramment utilisés dans l’écosystème Cloud Native).
Merci de faire savoir aux mainteneurs que vous avez soumis un terme sur Slack, sinon il pourrait passer à côté. Idéalement, mentionnez @Catherine Paganini, @jmo, @Seokho Son, @Jihoon Seo, and/or @iamnoah.
Si le terme est approuvé et que vous voulez travailler dessus, ils vous assigneront l’issue.
Notez que vous pouvez vous assigner qu’à un seul terme à la fois. Si vous souhaitez travailler sur plusieurs termes, merci d’en finir un avant de vous en attribuer un autre
Proposer un nouveau terme (créer une PR)
Avant de commencer, merci de lire le Style Guide — il aidera à minimiser les aller/retour. Comme mentionné dans le style guide, il est fortement recommandé de commencer par un document texte (Gdoc, Word ou autre)
Une fois que le terme est prêt à être proposé, rédigez le contenu (sous forme de code)…
…Alors “fr” (ou la langue pour laquelle vous souhaitez contribuer)…
… Et sélectionner _TEMPLATE.md
…Copier le contenu…
…Et retourner sur le dossier “fr”. Et cliquer sur “Add file” et sélectionner “Create new file”.
Ajouter le terme dans l’url (pas de majuscules, pas d’espaces, pas de parenthèses et utiliser un tiret pour séparer les mots) rajouter .md à la fin du nom de votre fichier (note: Si la prévisualisation ne fonctionne pas, vous avez probablement oublié d’ajouter .md à la fin). Maintenant copier le contenu. Copier et coller votre définition dans le fichier. Pour faciliter les relectures, merci d’utiliser semantic line breaks (e.g. une ligne par phrase).
Github utilise le format markdown pour mettre en forme le text (e.g., lien hypertexte, gras, italic). Merci de lire ceci markdown cheat sheet. Pour vérifier que vous avez correctement utilisé markdown, aller sur “Preview”.
Descendre en bas de la page et donner un nom à votre commit quand vous êtes prêt à l’ajouter. Vous êtes, maintenant, prêt à commit votre terme sur votre propre branche. Proposer une PR nécessite une dernière étape. Cliquer sur “Commit new file” et…
…Maintenant vous créez une PR :
Vous devriez voir votre PR sous “Pull requests”.
Mettre à jour un terme existant
Pour mettre à jour un terme existant, vous pouvez soit suggérer un changement via un ticket (issue) ou directement proposer la mise à jour d’un terme en soumettant une pull request (PR).
Proposer un changement via un ticket
Si vous voulez mettre en évidence un problème mais que vous ne savez pas ou ne voulez pas le corriger vous même, cliquez sur “Report issue'.
Cela va directement ouvrir un ticket. Merci d’être précis sur quels changements sont nécessaires et pourquoi. Cliquer sur “submit” et c’est fini.
Mettre à jour un terme directement
Pour directement changer un terme, aller sur “Edit this page”.
Cela va ouvrir la page GitHub du terme. Faites vos changements et proposer une PR. Merci de prendre connaissance de “Proposer un nouveau terme” avant pour une description détaillé (sauter la section qui parle de markdown)
Aider à traduire le glossaire
Pour aider à traduire le glossaire dans votre langue principale, merci de rejoindre le Slack et le channel #glossary-localizations et faites le nous savoir.
Vous pouvez soit rejoindre une équipe existante ou en créer une nouvelle (pour voir en quoi ça consiste, regarder Localization Guide).
Merci aussi de rejoindre notre réunion mensuelle. Vous pouvez trouver plus de détails sur le CNCF calendar.