Souhaitez-vous devenir un responsable de ce projet et aider à le maintenir? Si vous êtes intéressé, envoyez moi un DM sur Twitter et lisez le guide du mainteneur.
Ceci est un tutoriel pour aider les nouveaux contributeurs à participer à un projet simple et facile.
- Apporter une contribution à un projet open source.
- Devenir plus à l'aise dans l'utilisation GitHub.
Ce tutoriel est également disponible dans d'autres langues (Actuellement disponible en Portugais, Espagnol, et Italien. Des traductions sont les bienvenue).
- Ceci est pour les débutants absolus. Si vous savez comment écrire et modifier une balise d'ancrage
<a href="" target=""></a>alors vous devriez pouvoir le faire. - C'est pour ceux qui ont un peu plus d'expérience mais qui veulent faire leur première contribution open source, ou obtenir plus de contributions pour plus d'expérience et de confiance.
Tout développeur Web, en herbe ou expérimenté, doit utiliser le contrôle de version Git, et GitHub est le service d'hébergement Git le plus populaire utilisé dans le monde. C'est aussi le cœur de la communauté Open Source. Se familiariser avec GitHub est une compétence essentielle. Contribuer à un projet renforce votre confiance et vous donne quelque chose à afficher sur votre profil GitHub.
Si vous êtes un nouveau développeur et que vous vous demandez si vous avez besoin d'apprendre Git et GitHub, voici la réponse: Vous auriez dû apprendre Git hier.
Vous allez contribuer une carte comme celle-ci à la page web du projet. Il comprendra votre nom, votre pseudo Twitter, une brève description et 3 liens vers des ressources utiles pour les développeurs Web que vous recommandez.
Vous allez faire une copie du modèle de carte dans le fichier HTML et le personnaliser avec vos propres informations.
Ce tutoriel est également disponible dans d'autres langues (Arabe, Français, Allemagne, Italien, Coréen, Polonais, Portugais, Serbien, Espagnol, and Turc actuellement. Des traductions pour ce README ou le fichier README des responsables sont les bienvenues!).
- Connectez-vous à votre compte GitHub. Si vous n'avez pas encore de compte, rejoindre GitHub. Je vous recommande de faire le Tutoriel GitHub Hello World avant de continuer.
- Télécharger GitHub Desktop app.
- Alternativement, si vous êtes à l'aise avec Git sur la ligne de commande, vous pouvez le faire (voicifirst-contributions, a similar project that can serve as a guide for the commands needed). OR -Si tu utilises VS Code il est livré avec Git intégré et vous permet de faire ce dont nous avons besoin directement depuis l'éditeur.
- Cependant, le moyen le plus simple et le plus simple de suivre ce didacticiel consiste à utiliser GitHub Desktop.
Maintenant que vous êtes tous configurés, continuons à contribuer au projet.
Bdevenir un contributeur open source en 10 étapes faciles.
Temps estimé: moins de 30 minutes.
- L'objectif ici est de faire une copie de ce projet et de le placer dans votre compte.
- Un référentiel (repo) est la façon dont un projet est appelé sur GitHub et un fork en est une copie.
- Assurez-vous que vous êtes sur la page principale de ce repo.
|
 |
|---|
- Vous avez maintenant une copie complète du projet dans votre propre compte
- Maintenant, nous voulons faire une copie locale du projet. C'est une copie enregistrée sur votre propre machine.
- Ouvrez l'application de bureau GitHub. Dans l'appli:
|
 |
|---|
|
 |
|---|---|
|
 |
- Cela prendra un moment pendant que le projet est copié sur votre disque dur. Je vous recommande de conserver le chemin par défaut qui est généralement
.. \ Documents \ GitHub. - Vous disposez maintenant d'une copie locale du projet.
- Une fois que le repo a été clonée et que vous l’avez ouvert dans GitHub Desktop, il est temps de créer une nouvelle branche.
- Une branche est un moyen de séparer vos modifications de la partie principale du projet appelée
Master. Par exemple, si les choses tournent mal et que vous n’êtes pas satisfait de vos modifications, vous pouvez simplement supprimer la branche et le projet principal ne sera pas affecté.
|
 |
|---|
|
 |
|---|
- Vous pouvez le nommer comme vous voulez, mais comme il s’agit d’une branche pour ajouter une carte avec votre nom au projet, appelez-le
your-name-cardest une bonne pratique parce qu’elle maintient l’intention de cette branche claire.
|
 |
|---|
- Vous avez maintenant créé une nouvelle branche distincte du maître.
- Pour les étapes suivantes, assurez-vous que vous travaillez dans cette branche. Vous verrez le nom de la branche sur laquelle vous vous trouvez en haut au centre de l’application de bureau GitHub où il est dit Current branch.
Na PAS travailler sur la branche master
- Maintenant, nous devons ouvrir le fichier que nous allons éditer avec votre éditeur de code préféré.
- Recherchez le dossier du projet sur votre ordinateur. Si vous avez conservé la valeur par défaut, cela devrait être quelque chose comme
your-computer > Documents > GitHub > Contribute-To-This-Project - Le fichier
index.htmlest directement dans le dossierContribute-To-This-Project.
|
 |
|---|
- Maintenant, vous avez le fichier que vous allez modifier ouvert dans votre éditeur et vous êtes prêt à commencer à y apporter des modifications.
- Nous allons faire une copie du modèle de carte pour commencer à travailler dessus
|
|---|
 |
|
|---|
 |
- C’est maintenant votre carte à personnaliser et à modifier.
- Nous allons maintenant commencer à éditer le html, en changeant les champs personnalisables de notre carte.
|
 |
|---|
|
|---|
 |
- Si vous préférez utiliser un contact autre que Twitter, vous devrez remplacer l'icône Twitter
<i class =" fa fa-twitter "> </i>en accédant à Font Awesome Icons en recherchant la bonne icône et en remplaçant uniquement la partiefa-twitterpar la nouvelle icône commefa-facebookpar exemple. Suivez ensuite les mêmes étapes ci-dessus.
|
 |
|---|
|
|---|
 |
|
- Assurez-vous d'avoir ** enregistré toutes vos modifications **.
- ** Testez vos modifications **. C'EST IMPORTANT! Ouvrez le fichier html dans votre navigateur (en double-cliquant dessus par exemple) et voyez à quoi ressemblera votre carte sur le site. Vérifiez que la page entière est toujours la même et que rien n'est cassé Cliquez sur vos liens et assurez-vous qu'ils fonctionnent. Ouvrez la console (Ctrl + Maj + J (Windows / Linux) ou Cmd + Opt + J (Mac)) et vérifiez qu'il n'y a pas de messages d'erreur.
- Génial, vous avez fini de modifier votre code! Les étapes suivantes enverront vos modifications à GitHub, puis les soumettront pour être fusionnées avec le projet principal.
- Revenez à l'application de bureau GitHub.
- Vos modifications auront été ajoutées automatiquement à la zone de préparation.
- Cela signifie que Git a enregistré toutes les modifications ** enregistrées **.
- Vous pouvez voir cela reflété dans l'application. Tout ce que vous avez ajouté au fichier sera en vert et les suppressions s'afficheront en rouge.
|
 |
|---|
|
|---|
 |
|
 |
|---|
- Vos modifications sont maintenant enregistrées ou validées. Mais ils ne sont enregistrés que localement, c'est-à-dire sur votre ordinateur.
- La synchronisation des modifications locales avec votre référentiel sur Github s'appelle un Push. Vous «poussez» les modifications de votre référentiel local vers le référentiel distant sur Github.
|
 |
|---|
- Après quelques secondes, l'opération est terminée et vous avez maintenant exactement la même copie de cette branche sur votre machine ainsi que sur GitHub.
- C'est le moment que vous attendiez; soumettre une Pull Request (PR).
- Jusqu'à présent, tout le travail que vous avez effectué a été sur la fourche du projet, qui, comme vous vous en souvenez, réside sur votre propre compte de GitHub.
- Il est maintenant temps d'envoyer vos modifications au projet principal pour les fusionner.
- C'est ce qu'on appelle un Demande de tirage parce que vous demandez au responsable du projet d'origine de "tirer" vos modifications dans son projet.
- Accédez à la page principale de votre fork sur GitHub (il aura l'icône de fork et votre propre nom d'utilisateur en haut).
- Vers le haut du dépôt, vous verrez un message de demande de tirage en surbrillance avec un bouton vert.
|
 |
|---|
|
|---|
 |
|
 |
|---|
- Ne soyez pas déconcerté par toutes les options. Il vous suffit de suivre ces trois étapes pour le moment.
- Laissez cochée l'option «Autoriser les modifications des responsables».
- Maintenant, une Pull Request sera envoyée au responsable du projet. Dès qu'ils seront examinés et acceptés, vos modifications apparaîtront sur le page Web du projet.
C'est tout. Vous l'avez fait! Vous avez maintenant contribué à l'open source sur GitHub.
Vous avez ajouté du code à une page Web en direct: https://syknapse.github.io/Contribute-To-This-Project
Vos modifications ne seront pas visibles immédiatement; ils doivent d'abord être examinés, acceptés et fusionnés par le responsable du projet. Une fois qu'ils sont fusionnés, votre carte doit être visible et en direct sur la page.
Il est tout à fait normal qu'un critique demande des modifications sur un PR. Considérez cela comme une bonne pratique si cela vous arrive. Gardez un œil sur les commentaires et les modifications demandées. Une fois que vous avez effectué les modifications demandées (de retour dans votre branche), il ne vous reste plus qu'à valider et à pousser vos modifications. Le PR se mettra automatiquement à jour avec les nouvelles modifications.
Je promets que je vais essayer de revoir et de fusionner dès que possible, mais je le fais pendant mon temps libre, donc un retard de quelques jours est inévitable.
- Revenez dans un moment pour vérifier votre demande de tirage fusionnée.
- Vous devriez recevoir un e-mail de GitHub lorsque vos modifications ont été approuvées ou si des modifications supplémentaires sont demandées. Et quand le PR est finalement fusionné avec le maître et que votre carte a été ajoutée.
- Si vous avez trouvé ce projet utile merci de lui donner un: star: star: star: en haut de la page et Tweet à ce sujet pour aider à faire passer le mot
- You can follow me and get in touch on Twitter or using any of these other options
- This is an open source project so apart from contributing your card you are welcome to help fix bugs, improvements, or new features. Open an issue or send a new pull request
- Thanks for contributing to this project. Now you can go ahead and try contributing to other projects; look for the
label for beginner-friendly contribution options. - I'm also looking for collaborators to give me a hand in reviewing and merging PRs. If you would like to get more advanced Git practice please send me a DM on Twitter and read the collaborator's guide.
Ce projet est fortement influencé par le projet Roshan Jossey premières contributions avec son excellent tutoriel.
Il est également particulièrement inspiré par la grande communauté autour de #GoogleUdacityScholars The Google Challenge Scholarship: Front-End Web Dev, promotion 2017 Europe.