Adding a Project

Do you want to add a new Bitcoin "project" to the Plan ₿ Academy site and give visibility to your company or software, but don't know how? This tutorial is for you!

• First, you need to have a GitHub account. If you don't know how to create an account, we have made a detailed tutorial to guide you.

GitHub AccountHow to create your own account on GitHub?

• Go to the GitHub repository of PlanB dedicated to data in the resources/project/ section:
• Click on the top right on the Add file button, then on Create new file:
• If you have never contributed to the contents of Plan ₿ Academy before, you will need to create your fork of the original repository. Forking a repository means creating a copy of that repository on your own GitHub account, which allows you to work on the project without affecting the original repository. Click on the Fork this repository button:
• You will then arrive at the GitHub editing page:
• Create a folder for your company. To do this, in the Name your file... box, write the name of your company in lowercase with dashes instead of spaces. For example, if your company is called "Bitcoin Baguette", you should write bitcoin-baguette:
• To validate the creation of the folder, simply add a slash after your name in the same box, for example: bitcoin-baguette/. Adding a slash automatically creates a folder rather than a file:
• In this folder, you will create a first YAML file named project.yml:
• Fill this file with information about your company using this template:

name:

address_line_1:
address_line_2:
address_line_3: 

language:
  - 

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

tags:
  - 
  - 

category:

• name: The name of your company (mandatory);
• address : The location of your business (optional);
• language : The countries your business operates in or the languages supported (optional);
• links : The various official links of your business (optional);
• tags : 2 terms that qualify your business (mandatory);
• category : The category that best describes the field in which your business operates among the following choices:
  • 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

• Once you have finished making changes to this file, save them by clicking on the Commit changes... button:
• Add a title for your changes, along with a short description:
• Click on the green Propose changes button:
• You will then arrive at a page summarizing all your changes:
• Click on your GitHub profile picture at the top right, then on Your Repositories:
• Select your fork of the Plan ₿ Academy repository:
• You should see a notification at the top of the window with your new branch. It's probably called patch-1. Click on it:
• You are now on your working branch (make sure you are on the same branch as your previous modifications, this is important!):
• Go back to the resources/projects/ folder and select the folder of your business that you just created in the previous commit:
• In the folder of your business, click on the Add file button, then on Create new file:
• Name this new folder assets and confirm its creation by putting a slash / at the end:
• In this assets folder, create a file named .gitkeep:
• Click on the Commit changes... button:
• Leave the commit title as default, and make sure the Commit directly to the patch-1 branch box is checked, then click on Commit changes:
• Go back to the assets folder:
• Click on the Add file button, then on Upload files:
• A new page will open. Drag and drop an image of your company or your software into the area. This image will be displayed on the Plan ₿ Academy site:
• It can be the logo or an icon:
• Once the image is uploaded, verify that the Commit directly to the patch-1 branch box is checked, then click on Commit changes:
• Be careful, your image must be square, must be named logo, and must be in .webp format. The full file name should therefore be: logo.webp:
• Go back to your assets folder and click on the .gitkeep intermediate file:
• Once on the file, click on the three small dots at the top right then on Delete file:
• Verify that you are still on the same working branch, then click on the Commit changes button:
• Add a title and a description to your commit, then click on Commit changes:
• Go back to your company's folder:
• Click on the Add file button, then on Create new file:
• Create a new YAML file by naming it with the indicator of your native language. This file will be used for the description of the project. For example, if I want to write my description in English, I will name this file en.yml:
• Fill out this YAML file using this template:

description: |
 
contributors:
 - 

• For the contributors key, you can add your contributor identifier to Plan ₿ Academy if you have one. If you don't, leave this field empty.
• For the description key, you simply need to add a short paragraph that describes your company or your software. The description must be in the same language as the file name. You do not need to translate this description into all the languages supported on the site, as the PlanB teams will do so using their model. For example, here is what your file could look like:

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:
- 

• Click on the Commit changes button:
• Ensure the Commit directly to the patch-1 branch box is checked, add a title, then click on Commit changes:
• Your company folder should now look like this:
• If everything is to your satisfaction, return to the root of your fork:
• You should see a message indicating that your branch has undergone changes. Click on the Compare & pull request button:
• Add a clear title and description to your PR:
• Click on the Create pull request button: Congratulations! Your PR has been successfully created. An administrator will now review it and, if everything is in order, integrate it into the main repository of Plan ₿ Academy. You should see your project profile appear on the website a few days later.

Be sure to follow the progress of your PR. An administrator may leave a comment asking for additional information. As long as your PR is not validated, you can consult it in the Pull requests tab on the Plan ₿ Academy GitHub repository: Thank you very much for your valuable contribution! :)