Ajouter un projet

• Tout d'abord, il vous faut avoir un compte sur GitHub. Si vous ne savez pas comment créer un compte, nous avons fait un tutoriel détaillé pour vous accompagner.

Compte GitHubComment créer son propre compte sur GitHub ?

• Rendez-vous sur le dépôt GitHub de Plan₿ dédié à la data dans la section resources/project/ :

• Cliquez en haut à droite sur le bouton Add file, puis sur Create new file :

• Si vous n'avez encore jamais contribué sur les contenus de Plan ₿ Academy, vous allez devoir créer votre fork du dépôt original. Faire un fork d'un dépôt consiste à créer une copie de ce dépôt sur votre propre compte GitHub, ce qui vous permet de travailler sur le projet sans affecter le dépôt original. Cliquez sur le bouton Fork this repository :

• Vous arrivez ensuite sur la page d'édition de GitHub :

• Créez un dossier pour votre entreprise. Pour ce faire, dans la case Name your file..., notez le nom de votre entreprise en minuscules avec des tirets à la place des espaces. Par exemple, si votre entreprise s'appelle "Bitcoin Baguette", vous devez noter bitcoin-baguette :

• Pour valider la création du dossier, il suffit de noter un slash à la suite de votre nom dans la même case, par exemple : bitcoin-baguette/. Le fait d'ajouter un slash permet de créer automatiquement un dossier plutôt qu'un fichier :

• Dans ce dossier, vous allez créer un premier fichier YAML nommé project.yml :

• Remplissez ce fichier avec les informations relatives à votre entreprise à l'aide de ce modèle :

name:

address_line_1:
address_line_2:
address_line_3: 

language:
  - 

links:
  website:
  twitter:
  Github:
  youtube:
  nostr:

tags:
  - 
  -

category:

• name : Le nom de votre entreprise (obligatoire) ;
• address : Le lieu de votre entreprise (facultatif) ;
• language : Les pays dans lesquels votre entreprise se trouve ou les langues prises en charge (facultatif) ;
• links : Les différents liens officiels de votre entreprise (facultatif) ;
• tags : 2 termes qui qualifient votre entreprise (obligatoire) ;
• category : La catégorie qui qualifie le mieux le domaine dans lequel votre entreprise opère parmi les choix suivants :
  • wallet,
  • infrastructure,
  • exchange,
  • education,
  • service,
  • communities,
  • conference,
  • privacy,
  • investment,
  • node,
  • mining,
  • news,
  • manufacturer.

name: Bitcoin Baguette

address_line_1: Paris, France
address_line_2:
address_line_3: 

language:
  - fr
  - en

links:
  website: https://bitcoin-baguette.com
  twitter: https://twitter.com/bitcoinbaguette
  Github:
  youtube:
  nostr:

tags:
  - bitcoin
  - education

category: education

• Une fois vos modifications sur ce fichier terminées, enregistrez-les en cliquant sur le bouton Commit changes... :

• Ajoutez un titre pour vos modifications, ainsi qu'une courte description :

• Cliquez sur le bouton vert Propose changes :

• Vous arrivez ensuite sur une page qui résume tous vos changements :

• Cliquez sur votre image de profil GitHub en haut à droite, puis sur Your Repositories :

• Sélectionnez votre fork du dépôt de Plan ₿ Academy :

• Vous devriez voir apparaître sur le haut de la fenêtre une notification avec votre nouvelle branche. Elle s'appelle sûrement patch-1. Cliquez dessus :

• Vous êtes maintenant sur votre branche de travail (vérifiez que vous êtes bien sur la même branche que vos modifications précédentes, c'est important !) :

• Retournez dans le dossier resources/projects/ et sélectionnez le dossier de votre entreprise que vous venez de créer dans le commit précédent :

• Dans le dossier de votre entreprise, cliquez sur le bouton Add file, puis sur Create new file :

• Nommez ce nouveau dossier assets et confirmez sa création en mettant un slash / à la fin :

• Dans ce dossier assets, créez un fichier nommé .gitkeep :

• Cliquez sur le bouton Commit changes... :

• Laissez le titre du commit par défaut, et vérifiez bien que la case Commit directly to the patch-1 branch est cochée, puis cliquez sur Commit changes :

• Retournez dans le dossier assets :

• Cliquez sur le bouton Add file, puis sur Upload files :

• Une nouvelle page va s'ouvrir. Glissez et déposez dans la zone une image de votre entreprise ou de votre logiciel. C'est cette image qui sera affichée sur le site de Plan ₿ Academy :

• Ça peut être le logo ou une icône :

• Une fois l'image chargée, vérifiez que la case Commit directly to the patch-1 branch est cochée, puis cliquez sur Commit changes :

• Attention, votre image doit être carrée, doit s'appeler logo et doit être au format .webp. Le nom complet du fichier devrait donc être : logo.webp :

• Retournez dans votre dossier assets et cliquez sur le fichier intermédiaire .gitkeep :

• Une fois sur le fichier, cliquez sur les 3 petits points en haut à droite, puis sur Delete file :

• Vérifiez que vous êtes toujours sur la même branche de travail, puis cliquez sur le bouton Commit changes... :

• Ajoutez un titre et une description à votre commit, puis cliquez sur Commit changes :

• Retournez dans le dossier de votre entreprise :

• Cliquez sur le bouton Add file, puis sur Create new file :

• Créez un nouveau fichier YAML en le nommant avec l'indicateur de votre langue natale. Ce fichier va être utilisé pour la description du project. Par exemple, si je veux rédiger ma description en anglais, je vais nommer ce fichier en.yml :

• Remplissez ce fichier YAML à l'aide de ce modèle :

description: |
 
contributors:
 - 

• Pour la clé contributors, vous pouvez ajouter votre identifiant de contributeur à Plan ₿ Academy si vous en avez un. Si vous n'en avez pas, laissez ce champ vide.
• Pour la clé description, vous devez simplement ajouter un court paragraphe qui décrit votre entreprise ou votre logiciel. La description doit être dans la même langue que le nom du fichier. Vous n'avez pas besoin de traduire cette description dans toutes les langues prises en charge sur le site, car les équipes de Plan₿ le feront avec leur modèle. Par exemple, voici à quoi pourrait ressembler votre fichier :

description: |
 Founded in 2017, Bitcoin Baguette is a Paris-based association dedicated to organizing Bitcoin meetups and technical workshops. We bring together enthusiasts, experts, and curious minds to explore and discuss the intricacies of Bitcoin technology. Our events provide a platform for knowledge sharing, networking, and fostering a deeper understanding of Bitcoin's inner workings. Join us at Bitcoin Baguette to be a part of Paris's Bitcoin community and stay updated with the latest advancements in the field.
contributors:
 - 

• Cliquez sur le bouton Commit changes... :

• Vérifiez que la case Commit directly to the patch-1 branch est cochée, ajoutez un titre, puis cliquez sur Commit changes :

• Le dossier de votre entreprise devrait dorénavant ressembler à celui-ci :

• Si tout vous convient, revenez à la racine de votre fork :

• Vous devriez voir apparaître un message vous indiquant que votre branche a subi des modifications. Cliquez sur le bouton Compare & pull request :

• Ajoutez un titre clair et une description sur votre PR :

• Cliquez sur le bouton Create pull request :