Contribuer à cette documentation
Nous vous remercions de l’intérêt que vous portez à notre documentation.
- Contribuer à l’aide de GitHub
- Contribuer à l’aide de Git
- Utilisation de Markdown pour mettre en forme votre rubrique
- Conventions de balisage & règles spécifiques à ce dépôt
- FAQ
- Autres ressources
Utilisez GitHub pour contribuer à cette documentation sans avoir à cloner le référentiel sur votre bureau. Il s’agit du moyen le plus simple de créer une demande de tirage dans ce dépôt. Utilisez cette méthode pour apporter une modification mineure qui n’implique pas de modifications de code. Cette méthode vous permet de contribuer à un article à la fois.
- Recherchez l’article auquel vous souhaitez contribuer sur GitHub.
- Une fois que vous êtes sur l’article dans GitHub, connectez-vous à GitHub (obtenez un compte gratuit Rejoindre GitHub).
- Choisissez l’icône crayon (modifiez le fichier dans votre duplication de ce projet) et apportez vos modifications dans la fenêtre Modifier le <>fichier .
- Faites défiler vers le bas et entrez une description.
- Choisissez Proposer une modification> de fichierCréer une demande de tirage.
Vous avez maintenant envoyé une demande de tirage. Les demandes de tirage sont généralement examinées dans les 10 jours ouvrables.
Utilisez Git pour apporter des modifications substantielles, telles que :
- Code de contribution.
- Contribution des modifications qui affectent la signification.
- Contribution de modifications importantes au texte.
- Ajout de nouvelles rubriques.
Si vous n’avez pas de compte GitHub, configurez-en un sur GitHub.
Une fois que vous avez un compte, installez Git sur votre ordinateur. Suivez les étapes du tutoriel [Configurer Git].
Pour envoyer une demande de tirage à l’aide de Git, suivez les étapes décrites dans Utiliser GitHub, Git et ce référentiel.
Vous serez invité à signer le Contrat de licence du contributeur si vous êtes :
- Membre du groupe Microsoft Open Technologies.
- Un contributeur qui ne fonctionne pas pour Microsoft.
En tant que membre de la communauté, vous devez signer le Contrat de licence de contribution (CLA) avant de pouvoir contribuer à de grandes soumissions à un projet. Vous ne devez remplir et envoyer la documentation qu’une seule fois. Lisez attentivement le document. Il faudra peut-être que votre employeur signe le document.
La signature de la cla cla ne vous accorde pas le droit de vous engager dans le dépôt main, mais cela signifie que les équipes de développement Office et de publication de contenu pour les développeurs Office seront en mesure d’examiner et d’approuver vos contributions. Vous êtes crédité pour vos soumissions.
Les demandes de tirage sont généralement examinées dans les 10 jours ouvrables.
Notes
La plupart des informations contenues dans cette section se trouvent dans les articles [Aide GitHub]. Si vous êtes familiarisé avec Git et GitHub, passez à la section Contribuer et modifier du contenu pour connaître les spécificités du flux de code/contenu de ce dépôt.
Configurez un compte GitHub pour pouvoir contribuer à ce projet. Si vous ne l’avez pas fait, accédez à GitHub et faites-le maintenant.
Installez Git sur votre ordinateur. Suivez les étapes du tutoriel [Configurer Git].
Créez votre propre bifurcation du référentiel. Pour ce faire, en haut de la page, choisissez le bouton Dupliquer .
Copiez votre duplication sur votre ordinateur. Pour ce faire, ouvrez Git Bash. À l’invite de commandes, entrez les informations suivantes :
git clone https://github.com/<your user name>/<repo name>.git
Créez ensuite une référence vers le référentiel racine en entrant les commandes suivantes :
cd <repo name>
git remote add upstream https://github.com/OfficeDev/<repo name>.git
git fetch upstream
Félicitations ! Vous avez maintenant configuré votre dépôt. Vous n’aurez pas besoin de répéter ces étapes.
Pour rendre le processus de contribution aussi transparent que possible, procédez comme suit.
- Créez une branche.
- Ajoutez du nouveau contenu ou modifiez le contenu existant.
- Envoyez une requête de tirage au référentiel principal.
- Supprimez la branche.
Important : Limitez chaque branche à un seul concept/article pour simplifier le flux de travail et réduire les risques de conflits de fusion. Le contenu approprié pour une nouvelle branche comprend :
- Un nouvel article.
- Corrections orthographiques et grammaticales.
- Application d’une seule modification de mise en forme sur un grand ensemble d’articles (par exemple, l’application d’un nouveau pied de page de copyright).
- Ouvrez Git Bash.
- À l’invite de commandes Git Bash, tapez
git pull upstream main:<new branch name>
. Cela crée une branche localement qui est copiée à partir de la dernière branche OfficeDev main. - À l’invite de commandes Git Bash, tapez
git push origin <new branch name>
. Cela avertit GitHub de la nouvelle branche. La nouvelle branche doit maintenant apparaître dans votre bifurcation du référentiel de GitHub. - À l’invite de commandes Git Bash, tapez
git checkout <new branch name>
pour basculer vers votre nouvelle branche.
Vous accédez au référentiel sur votre ordinateur à l’aide de Explorateur de fichiers. Les fichiers du dépôt se trouvent dans C:\Users\<yourusername>\<repo name>
.
Pour modifier des fichiers, ouvrez-les dans l’éditeur de votre choix et modifiez-les. Pour créer un fichier, utilisez l’éditeur de votre choix et enregistrez le nouveau fichier à l’emplacement approprié dans votre copie locale du dépôt. Pendant que vous travaillez, enregistrez votre travail fréquemment.
Les fichiers dans C:\Users\<yourusername>\<repo name>
sont une copie de travail de la nouvelle branche que vous avez créée dans votre dépôt local. Si vous effectuez des modifications dans ce dossier, le référentiel local ne sera pas altéré tant que vous ne validez pas les modifications. Pour valider une modification dans le référentiel local, entrez les commandes suivantes dans GitBash :
git add .
git commit -v -a -m "<Describe the changes made in this commit>"
La commande add
ajoute vos modifications dans une zone de transit pour qu’elles soient validées dans le référentiel. La période après la add
commande spécifie que vous souhaitez mettre en scène tous les fichiers que vous avez ajoutés ou modifiés, en vérifiant les sous-dossiers de manière récursive. (Si vous ne souhaitez pas valider toutes les modifications, vous pouvez ajouter des fichiers spécifiques. Vous pouvez également annuler une validation. Pour obtenir de l’aide, tapez git add -help
ou git status
.)
La commande commit
applique les modifications en attente dans le référentiel. Le commutateur -m
signifie que vous fournissez le commentaire de validation dans la ligne de commande. Les commutateurs -v et -a peuvent être omis. Le commutateur -v est destiné à la sortie détaillée de la commande, et -a fait ce que vous avez déjà fait avec la commande add.
Vous pouvez valider plusieurs fois pendant que vous effectuez votre travail, ou vous pouvez valider une fois lorsque vous avez terminé.
Lorsque vous avez terminé votre travail et que vous êtes prêt à le fusionner dans le référentiel main, procédez comme suit.
- Dans l’invite de commandes Git Bash, tapez
git push origin <new branch name>
. Dans le référentiel local,origin
fait référence au référentiel GitHub à partir duquel vous avez cloné le référentiel local. Cette commande affiche l’état actuel de votre nouvelle branche, y compris toutes les validations effectuées au cours des étapes précédentes dans votre bifurcation GitHub. - Sur le site GitHub, accédez à la nouvelle branche dans votre bifurcation.
- Choisissez le bouton Demande de tirage en haut de la page.
- Vérifiez que la branche de base est
OfficeDev/<repo name>@main
et que la branche de tête est<your username>/<repo name>@<branch name>
. - Cliquez sur le bouton Mettre à jour la plage de validation .
- Ajoutez un titre à votre demande de tirage et décrivez toutes les modifications que vous apportez.
- Envoyez la requête de tirage.
L’un des administrateurs de site traite votre demande de tirage. Votre demande de tirage s’affiche sur le site officeDev/nom du référentiel sous Problèmes. Lorsque la demande de tirage est acceptée, le problème est résolu.
Une fois qu’une branche a été fusionnée (c’est-à-dire que votre demande de tirage est acceptée), ne continuez pas à travailler dans cette branche locale. Cela peut entraîner des conflits de fusion si vous envoyez une autre demande de tirage. Pour effectuer une autre mise à jour, créez une branche locale à partir de la branche en amont fusionnée, puis supprimez votre branche locale initiale.
Par exemple, si votre branche locale X a été fusionnée avec succès dans la branche OfficeDev/microsoft-graph-docs main et que vous souhaitez apporter des mises à jour supplémentaires au contenu qui a été fusionné. Créez une branche locale, X2, à partir de la branche OfficeDev/microsoft-graph-docs main. Pour ce faire, ouvrez GitBash et exécutez les commandes suivantes :
cd microsoft-graph-docs
git pull upstream main:X2
git push origin X2
Vous disposez maintenant de copies locales (dans une nouvelle branche locale) du travail que vous avez envoyé dans la branche X. La branche X2 contient également tout le travail que d’autres rédacteurs ont fusionné. Par conséquent, si votre travail dépend du travail d’autres personnes (par exemple, des images partagées), il est disponible dans la nouvelle branche. Vous pouvez vérifier que votre travail précédent (et celui des autres) se trouve dans la branche en consultant la nouvelle branche...
git checkout X2
...et vérifier le contenu. (La checkout
commande met à jour les fichiers dans C:\Users\<yourusername>\microsoft-graph-docs
à l’état actuel de la branche X2.) Une fois que vous case activée la nouvelle branche, vous pouvez apporter des mises à jour au contenu et les valider comme d’habitude. Toutefois, pour éviter de travailler par erreur dans la branche fusionnée (X), il est préférable de la supprimer (consultez la section suivante Supprimer une branche).
Une fois vos modifications fusionnées avec succès dans le référentiel main, supprimez la branche que vous avez utilisée, car vous n’en avez plus besoin. Tout travail supplémentaire doit être effectué dans une nouvelle branche.
- Dans l’invite de commandes Git Bash, tapez
git checkout main
. Ainsi, vous êtes sûr de ne pas vous trouver dans la branche à supprimer (ce qui est interdit). - Ensuite, à l’invite de commandes, tapez
git branch -d <branch name>
. Cela supprime la branche sur votre ordinateur uniquement si elle a été fusionnée avec succès dans le référentiel amont. (Vous pouvez remplacer ce comportement par l’indicateur–D
, mais vous devez d’abord être sûr de vouloir effectuer cette action.) - Enfin, entrez
git push origin :<branch name>
à l’invite de commandes (un espace avant le signe deux-points et pas d’espace après celui-ci). La branche est supprimée de votre bifurcation Github.
Félicitations, vous avez contribué avec succès au projet !
Tous les articles de ce référentiel utilisent Markdown. Une introduction complète (et la liste de toute la syntaxe) est disponible sur [Daring Fireball - Markdown].
Consultez les informations de référence de Docs Markdown dans notre guide contributeur.
Remplissez le formulaire sur Rejoindre GitHub pour ouvrir un compte GitHub gratuit.
Vous recevrez automatiquement une notification indiquant que vous devez signer le Contrat de licence du contributeur (CLA) si votre demande de tirage en requiert un.
En tant que membre de la communauté, vous devez signer le Contrat de licence de contributeur (CLA) pour pouvoir contribuer largement à ce projet. Vous ne devez remplir et soumettre la documentation qu’une seule fois. Lisez attentivement le document. Il faudra peut-être que votre employeur signe le document.
Lorsque vous soumettez vos modifications, par le biais d’une demande de tirage, notre équipe est avertie et examine votre demande de tirage. Vous recevrez des notifications sur votre demande de tirage à partir de GitHub . vous pouvez également être averti par une personne de notre équipe si nous avons besoin de plus d’informations. Si votre demande de tirage est approuvée, nous allons mettre à jour la documentation. Nous nous réservons le droit de modifier votre soumission pour des questions juridiques, de style, de clarté ou autres.
Actuellement, nous n’autoriseons pas les contributeurs externes à approuver les demandes de tirage dans ce dépôt.
Les demandes de tirage sont généralement examinées dans les 10 jours ouvrables.
- Pour en savoir plus sur Markdown, accédez au site du créateur de Markdown [Daring Fireball].
- Pour en savoir plus sur l’utilisation de Git et GitHub, commencez par case activée l’aide de GitHub.
Accueil GitHubAide GitHubConfigurer GitDaring Fireball - MarkdownDaring Fireball