Utiliser GitHub

Ce tutoriel GitHub est basé sur le [DjangoGirls How To Contribute Tutorial] (https://github.com/DjangoGirls/tutorial) qui est disponible sous une licence Creative Commons Attribution-ShareAlike 4.0.

Pour ce tutoriel, nous utiliserons le référentiel Briefcase comme base pour les liens et les références.

Démarrage et conditions préalables

Pour contribuer à BeeWare, les éléments suivants sont nécessaires pour commencer :

• un [compte GitHub] (https://github.com)
• dans le cas d'éditions complexes, une familiarité avec les bases de la ligne de commande Git de base de la ligne de commande ou la connaissance d'une application (Windows et Mac) pour pousser des fichiers. d'une application (Windows et Mac) pour transférer les les modifications effectuées sur votre ordinateur vers GitHub.

Créer un dépôt

Tout d'abord, créez le dépôt Briefcase sur votre compte GitHub personnel :

Édition de la documentation

Changements simples

Pour des changements simples comme des corrections de fautes de frappe, vous pouvez utiliser l'éditeur en ligne de GitHub GitHub :

• Ouvrez votre page de fork local sur GitHub,
• allez au fichier README.rst dans n'importe quel chapitre,
• appuyez sur l'icône Editer (stylo)

et vous pouvez éditer le chapitre directement sur github.com.

La syntaxe RST est utilisée pour éditer les différentes pages de la documentation.

Note

Sauvegardez vos modifications et créez une demande d'extraction comme expliqué ci-dessous.

Nouveau code et changements complexes

Pour ajouter du nouveau code, étendre des classes ou effectuer des modifications complexes, vous devez obtenir une copie du code sur votre ordinateur local.

Utilisez l'application GitHub pour votre système d'exploitation (mentionnée ci-dessus) ou la ligne de commande git pour obtenir le dépôt localement. git en ligne de commande pour obtenir le dépôt localement. Vous obtenez l'adresse du dépôt à partir de la page d'accueil de votre propre dépôt GitHub :

git clone git@github.com:yourusername/briefcase.git

Ensuite, créez une branche dans laquelle vous placerez vos nouvelles modifications. Il est utile d'appeler la branche de la branche quelque chose en rapport avec les modifications que vous allez apporter.

git checkout -b update_documentation

Apporter des modifications au code, s'assurer qu'elles sont testées et sauvegardées localement. localement.

Ensuite, livrez les changements en utilisant git et poussez les changements vers votre dépôt GitHub distant. GitHub distant.

Exemple :

$ git status
Sur la branche update_documentation
Fichiers non suivis :
  (utilisez "git add <file>..." pour les inclure dans ce qui sera livré)

    README.rst

git add README.rst

$ git commit -m "Mise à jour de la documentation README.rst pour Briefcase"
[update_documentation fe36152] Ajout d'une capture d'écran de gitbook
 1 fichier modifié, 0 insertions(+), 0 suppressions(-)
 mode de création 100644 README.rst

$ git push
Comptage des objets : 11, terminé.
Compression Delta utilisant jusqu'à 8 threads.
Compression des objets : 100% (5/5), terminé.
Écriture des objets : 100% (5/5), 266.37 KiB | 0 bytes/s, terminé.
Total 5 (delta 1), réutilisé 0 (delta 0)
Vers git@github.com:yourusername/briefcase.git
   b37ca59..fe36152 update_documentation -> update_documentation

Faire une pull request

Une fois que vous avez terminé vos modifications, vous devez créer une pull request sur GitHub. BeeWare sera notifié de la demande d'extraction, examinera vos modifications, suggérera des corrections si nécessaire et pull vos modifications à la version principale.

Dans votre propre dépôt sur GitHub, appuyez sur Compare & pull request.

Complétez les informations sur la raison de ce changement. Le réviseur peut voir les détails de la modification, il n'est donc pas nécessaire de répéter le contenu de la modification. le contenu de la modification.

Puis cliquez sur Create pull request.

Les courriels de GitHub vous informeront du processus de suivi.

---