Contribution à un projet

Découvrez comment contribuer à un projet par le biais de la duplication.

Platform navigation

Dans cet article

À propos de la duplication (fork)

Si vous souhaitez contribuer au projet de quelqu'un d'autre mais que vous n'avez pas l'autorisation d'y apporter des modifications directement, vous pouvez créer votre propre copie du projet, y apporter des mises à jour, puis suggérer que ces mises à jour soient incluses dans le projet principal. Ce processus est souvent appelé flux de travail « demande de duplication et demande de tirage ».

Lorsque vous créez votre propre copie (ou « duplication ») d'un projet, cela revient à créer un nouvel espace de travail qui partage le code avec le projet d'origine. Cette fonction est utile pour les projets à code source ouvert ou lorsque vous n'avez pas accès en écriture au projet original.

Une fois que vous avez effectué vos modifications dans votre copie, vous pouvez les soumettre en tant que demande d'extraction, ce qui est une façon de proposer des modifications au projet principal. Pour plus d’informations, consultez « Dupliquer (fork) un référentiel ».

Création de votre propre copie d’un projet

Ce tutoriel utilise le projet Spoon-Knife, un dépôt de test hébergé sur GitHub qui vous permet de tester le workflow de duplication (fork) et de demande de tirage (pull request).

  1. Accédez au projet Spoon-Knife à l’adresse https://github.com/octocat/Spoon-Knife.

  2. Dans le coin supérieur droit de la page, cliquez sur Dupliquer.

    Capture d’écran de la page principale d’un dépôt. Un bouton, étiqueté avec une icône de duplication (fork) et « Fork 59.3k », est encadré en orange foncé.

  3. Sous « Propriétaire », sélectionnez le menu déroulant et cliquez sur un propriétaire pour le dépôt dupliqué.

    Note

    Si votre nom d’utilisateur est grisé, c’est parce que le fork existe déjà. Au lieu de cela, vous devez mettre à jour votre fork existant. Pour plus d’informations, consultez « Synchronisation d’une duplication ».

  4. Par défaut, les duplications ont le même nom que leurs référentiels en amont. Si vous le souhaitez, pour mieux distinguer votre duplication, dans le champ « Nom du dépôt », tapez un nom.

  5. Dans le champ « Description », vous pouvez taper la description de votre duplication.

  6. Si vous le souhaitez, sélectionnez Copier la branche PAR DÉFAUT uniquement.

    Dans de nombreux scénarios de duplication, tels que la contribution à des projets open source, vous devez uniquement copier la branche par défaut. Si vous ne sélectionnez pas cette option, toutes les branches sont copiées dans la nouvelle duplication.

  7. Cliquez sur Créer une duplication.

Note

Si vous souhaitez copier des branches supplémentaires à partir du référentiel en amont, vous pouvez le faire depuis la page Branches. Pour plus d’informations, consultez « Création et suppression de branches dans votre référentiel ».

Clonage d'une duplication (fork) sur votre ordinateur

Vous avez correctement dupliqué (fork) le dépôt Spoon-Knife, mais jusqu’à présent, il existe uniquement sur GitHub Enterprise Server. Pour pouvoir travailler sur le projet, vous avez besoin de le cloner sur votre ordinateur.

Vous pouvez cloner votre duplication (fork) avec la ligne de commande, GitHub CLI ou GitHub Desktop.

  1. Sur GitHub Enterprise Server, accédez à votre duplication (fork) du dépôt Spoon-Knife.

  2. Au-dessus de la liste des fichiers, cliquez sur Code.

    Capture d’écran de la liste des fichiers dans la page d’accueil d’un dépôt. Le bouton « Code » est mis en évidence avec un encadré orange foncé.

  3. Copiez l’URL du dépôt.

    • Pour cloner le dépôt avec le protocole HTTPS, sous « HTTPS », cliquez sur .

    • Pour cloner le dépôt avec une clé SSH, en incluant un certificat émis par l’autorité de certification SSH de votre organisation, cliquez sur SSH et sur .

    • Pour cloner un dépôt avec l’GitHub CLI, cliquez sur GitHub CLI et sur .

      Capture d’écran du menu déroulant « Code ». À droite de l’URL HTTPS du dépôt, une icône de copie est indiquée en orange foncé.

  4. Ouvrez TerminalTerminalGit Bash.

  5. Remplacez le répertoire de travail actuel par l’emplacement où vous voulez mettre le répertoire cloné.

  6. Tapez git clone, puis collez l’URL que vous avez copiée précédemment. Voici ce à quoi cela ressemble, avec votre nom d’utilisateur GitHub Enterprise Server au lieu de YOUR-USERNAME :

    git clone https://HOSTNAME/YOUR-USERNAME/Spoon-Knife

  7. Appuyez sur Entrée. Votre clone local va être créé.

    $ git clone https://HOSTNAME/YOUR-USERNAME/Spoon-Knife
> Cloning into `Spoon-Knife`...
> remote: Counting objects: 10, done.
> remote: Compressing objects: 100% (8/8), done.
> remove: Total 10 (delta 1), reused 10 (delta 1)
> Unpacking objects: 100% (10/10), done.

Note

Pour plus d’informations sur GitHub CLI, consultez « À propos de GitHub CLI ».

Pour créer un clone de votre duplication, utilisez l’indicateur --clone.

gh repo fork REPOSITORY --clone=true

  1. Dans le menu Fichier, cliquez sur Cloner le dépôt.

    Capture d’écran de la barre de menus sur un Mac. Le menu déroulant « Fichier » est développé et l’option « Cloner le dépôt » est mise en évidence avec un contour orange.

    Capture d’écran de la barre de menus « GitHub Desktop » sur Windows. Le menu déroulant « Fichier » est développé et l’option « Cloner le dépôt » est mise en évidence avec un contour orange.

  2. Cliquez sur l’onglet qui correspond à l’emplacement du dépôt à cloner. Vous pouvez aussi cliquer sur l’URL pour entrer manuellement l’emplacement du dépôt.

    Capture d’écran de la fenêtre « Cloner un dépôt ». En haut de la fenêtre, les onglets intitulés « GitHub.com », « GitHub Enterprise » et « URL » sont mis en évidence avec un contour orange.

  3. Dans la liste des dépôts, cliquez sur le dépôt que vous souhaitez cloner.

    Capture d’écran de la fenêtre « Cloner un dépôt ». Le dépôt « github/docs », est mis en évidence avec un encadré orange.

  4. Pour sélectionner le répertoire local dans lequel vous souhaitez cloner le dépôt, en regard du champ « Chemin d’accès local », cliquez sur Choisir... et accédez au répertoire.

    Capture d’écran de la fenêtre « Cloner un dépôt ». Un bouton, intitulé « Choisir », est mis en évidence avec un encadré orange.

  5. En bas de la fenêtre « Cloner un dépôt », cliquez sur Cloner.

Création d’une branche sur laquelle travailler

Avant d’apporter des modifications au projet, vous devez créer une nouvelle branche et l’extraire. En conservant les modifications dans leur propre branche, vous suivez le flux GitHub et vous vous assurez qu'il sera plus facile de contribuer à nouveau au même projet à l'avenir. Consultez « GitHub flow ».

git branch BRANCH-NAME
git checkout BRANCH-NAME

git branch BRANCH-NAME
git checkout BRANCH-NAME

Pour plus d’informations sur la création et la gestion des branches dans GitHub Desktop, consultez « Gestion des branches dans GitHub Desktop ».

Apporter et pousser (push) des modifications

Poursuivez en apportant quelques modifications au projet à l’aide de votre éditeur de texte favori, comme Visual Studio Code. Vous pouvez, par exemple, modifier le texte index.html pour ajouter votre GitHub nom d'utilisateur.

Quand vous êtes prêt à soumettre vos modifications, indexez-les et commitez-les. git add . indique à Git que vous voulez inclure toutes vos modifications dans le commit suivant. git commit prend un instantané de ces modifications.

git add .
git commit -m "a short description of the change"

git add .
git commit -m "a short description of the change"

Pour plus d’informations sur la manière d’indexer et commiter des modifications dans GitHub Desktop, consultez « Commit et revue des changements apportés à votre projet dans GitHub Desktop ».

Quand vous indexez et commitez des fichiers, vous indiquez grosso modo à Git de prendre un instantané de vos modifications. Vous pouvez continuer à apporter d’autres modifications et prendre d’autres instantanés de commit.

Pour le moment, vos modifications existent uniquement en local. Quand vous êtes prêt à pousser (push) vos modifications vers GitHub Enterprise Server, poussez-les vers le dépôt distant.

git push

git push

Pour plus d’informations sur la façon de pousser (push) des modifications dans GitHub Desktop, consultez « Poussée de changements vers GitHub à partir de GitHub Desktop ».

Déroulement d’une demande de tirage

Enfin, vous voilà prêt à proposer des modifications dans le projet principal ! Il s’agit de la dernière étape de la production d’une duplication (fork) du projet d’une autre personne, et sans doute la plus importante. Si vous avez apporté une modification qui, à votre avis, pourrait être bénéfique pour l’ensemble de la communauté, envisagez sérieusement d’apporter votre contribution.

Pour cela, accédez au dépôt GitHub Enterprise Server où réside votre projet. Dans cet exemple, il s’agit de https://github.com/<your_username>/Spoon-Knife. Vous allez voir une bannière indiquant que votre branche a un commit d’avance sur octocat:main. Cliquez sur Contribuer, puis Ouvrir une demande de tirage.

GitHub Enterprise Server vous fait accéder à une page qui indique les différences entre votre duplication (fork) et le dépôt octocat/Spoon-Knife. Cliquez sur Create pull request (Créer une demande de tirage).

GitHub Enterprise Server vous fait accéder à une page dans laquelle vous pouvez entrer le titre et la description de vos modifications. Il est important de fournir autant d’informations utiles que possible, ainsi que la raison pour laquelle vous effectuez cette demande de tirage de prime abord. Le propriétaire du projet a besoin d’être en mesure de déterminer si votre modification s’avère aussi utile pour tout le monde que vous le pensez. Enfin, cliquez sur Créer une demande de tirage.

Gestion des commentaires

Les demandes de tirage sont un lieu de discussion. Ne vous sentez pas vexé si le propriétaire du projet rejette votre demande de tirage ou s’il demande plus d’informations sur la raison pour laquelle vous l’avez effectuée. Même si le propriétaire du projet choisit de ne pas fusionner votre demande de tirage, vos modifications existent toujours dans votre duplication. Il se peut que quelqu’un d’autre trouve votre duplication beaucoup plus utile que le projet d’origine.

Recherche de projets

Vous avez correctement dupliqué (fork) et contribué à un dépôt. Lancez-vous et contribuez encore !