Set up the project on your computer
In this chapter, we'll cover the essentials for getting your project up and running on your computer. Before plunging into the creation of your application or program, it's crucial to set up your development environment correctly.
Step 1 download the repo :
Go to our repo and fork the project.
When it is done. Clone your git repo on your computer.
Step 2 : install this extensions to VsCode
'Biome.js offers a comprehensive framework for building JavaScript applications, providing developers with a robust set of tools and features that streamline the development process.'
In fact we use biome as a linter and formater.
Step 3 install pnpm on you computer for the dependencies.
After that install the dependencies :
pnpm i
Step 4 change your branch to dev for getting the last update of this project.
git switch dev
Now that you've set up your development environment, you're ready to start contributing to the project.
Our aim is to ensure that the development of the game is regular and stable. To achieve this, we need to respect certain rules and take the time to communicate.
#1 Find a ticket
You can go to the issues DashBoard, And find any ticket:open. At this point read and ask question about the feature. If you think you can resolve the issue then ask to be assigned to it.
#2 Start to implements.
If you have read the set up documentation you supposed to be at the dev branch on your directory. If not git switch dev gonna help you. At this point you can create a branch.
The brakets
{...}it is something you supposed to replace.
git chekcout -b {annotation} with the good annotation :
Feature/{name of the feature}Bug/{Bug to resolve}Documentation/{Documentation to update}
#3 Create a pull Request
At this stage of the project, we need to improve and see what's best. So ask for a pull request as you wish, and in the future we'll make it more precise.