📦Environnement

Pré-requis

Avant de développer sur Papillon, il est nécessaire d'installer quelques outils, ces outils peuvent varier selon votre système d'exploitation.

Git

Node.js

Un éditeur de code tel que Visual Studio Code

Un Fork de Papillon

Android Studio (conseillé pour développer sur Android)

Bun (conseillé)

Outil(s) spécifiques à macOS

XCode

CocoaPods

Homebrew (conseillé)

Clonage du dépôt

Une fois que vous avez créé un fork de Papillon, vous allez pouvoir le télécharger localement afin d'y apporter des modifications via votre éditeur de code, pour cloner le fork, vous allez devoir utiliser l'outil Git, avec la commande suivante :

$ git clone https://github.com/PapillonApp/Papillon.git

Une fois que le dépôt est cloné, vous allez devoir installer ses dépendances, pour ce faire :

$ cd Papillon
$ npm install
$ npx expo prebuild

$ cd Papillon
$ npm install
$ npx expo prebuild
$ cd ios && pod install && cd ../

Tu peux ensuite ouvrir le dossier Papillon dans ton éditeur de code et commencer à faire des modifications, pour les tester, rien de plus simple, il suffit d'effectuer la commande spécifique à l'environnement sur lequel tu souhaites essayer :

$ npm run android

$ npm run ios

Effectuer sa première Pull Request ! 🎉

Une fois que tu as fait les modifications que tu voulais, tu peux créer une nouvelle branche à l'aide de la commande git checkout -b feature/super-cool, chez Papillon, nous respectons la spécification Conventional Branch afin de se repérer dans nos branches.

Ensuite, il te suffit d'ajouter tous les fichiers que tu souhaites pousser avec la commande git add [fichier] puis d'effectuer un commit avec git commit -m [titre de ton commit] -m [description], il n'est pas obligatoire de mettre une description, mais tu dois respecter la spécification Conventional Commits.

Une fois que tout ça est fait, tu peux enfin pousser les modifications vers ton fork à l'aide de la commande git push origin [nom de ta branche, et tu peux ensuite, en allant dans l'onglet Pull Requests du dépôt GitHub de Papillon, ouvrir ta Pull Request.

Et ensuite ?

Elle sera analysée en premier temps par un robot qui s'assurera de sa conformité avec les règles de contributions, si elle n'est pas conforme, elle obtiendra le label Invalide le temps que tu corriges ce qui ne va pas, ne t'inquiète pas, tout est expliqué par le robot sous ta Pull Request.

Après cette première analyse, nous analyserons manuellement ta Pull Request, nous pouvons à ce stade, soit valider, soit demander des changements, une fois que tout sera bon, elle sera fusionnée avec le code principal !