#1 correction du readme #4
29
readme.md
29
readme.md
@ -12,7 +12,7 @@ Moteur de jeu open source. L'[installation via steam](https://store.steampowered
|
||||
|
||||
#### [VSCodium](https://vscodium.com/)
|
||||
|
||||
Editeur de fichier texte (alternative : [VSCode](https://code.visualstudio.com/)). Optionnel si vous n'avez pas vocation à écrire/modifier du code.
|
||||
Éditeur de fichier texte (alternative : [VSCode](https://code.visualstudio.com/)). Optionnel si vous n'avez pas vocation à écrire/modifier du code.
|
||||
|
||||
#### [Git](https://git-scm.com/downloads)
|
||||
|
||||
@ -30,7 +30,7 @@ Après l'ouverture de Godot, choisissez importer et chercher l'emplacement ou vo
|
||||
|
||||
#### Godot et VSCode
|
||||
|
||||
Pour éditer le code du jeu avec VSCodium, aller dans les paramètres de l'éditeur de Godot (Editeur en haut à gauche), puis cherchez la page "Editeur de texte -> Externe". Ici, cochez la case en haut à droite de la fenêtre et remplissez les champs comme suit.
|
||||
Pour éditer le code du jeu avec VSCodium, allez dans les paramètres de l'éditeur de Godot (Éditeur en haut à gauche), puis cherchez la page "Éditeur de texte -> Externe". Ici, cochez la case en haut à droite de la fenêtre et remplissez les champs comme suit.
|
||||
|
||||
- Chemin d'exécution: `C:\Program Files\VSCodium\VSCodium.exe` (ou chemin de l'exécutable VSCode)
|
||||
- Paramètre d'exécution: `{project} --goto {file}:{line}:{col}`
|
||||
@ -63,29 +63,38 @@ player/
|
||||
└── player.tscn # Scène de l'objet
|
||||
```
|
||||
|
||||
Des sous dossiers peuvent également représenter plusieurs version de l'objet.
|
||||
Des sous dossiers peuvent également représenter plusieurs versions de l'objet.
|
||||
|
||||
## Contribuer au projet
|
||||
|
||||
Pour ajouter un ou plusieurs fichiers ou modifier du code dans le projet, suivez les procédure suivantes.
|
||||
Pour ajouter un ou plusieurs fichiers ou modifier du code dans le projet, suivez les procédures suivantes.
|
||||
|
||||
> Les termes "branches" et "commits" sont relatifs au fonctionnement de Git, et les "tickets" sont des tâches que l'on retrouve dans le [Gitea](https://git.zacharie-guet.fr/zacharie/seeding-planets/issues).
|
||||
> Les termes "branches" et "commits" (ou "révisions") sont relatifs au fonctionnement de Git, et les "tickets" sont des tâches que l'on retrouve dans le [Gitea](https://git.zacharie-guet.fr/zacharie/seeding-planets/issues).
|
||||
|
||||
### Modification de fichiers textes ou rennomage de dossiers/fichiers
|
||||
|
||||
1. Créez une branche dont le nom résume la modification. Les branches sont nommés en minuscule et avec des tirets "-" (exemple: `edit-jump-action`)
|
||||
1. Placez vous sur la branche `main` (`git checkout main` ou interface git) et récupérez les modification (`git pull` ou interface git)
|
||||
2. Créez une branche dont le nom résume la modification. Les branches sont nommés en minuscule et avec des tirets "-" (exemple: `edit-jump-action`)
|
||||
2. Après chaque modification conséquente, créer un ou plusieurs commits. Les noms des commits sont écrits en français et peuvent commencer par l'identifiant du ticket concernant la modification (exemple: `#5 augmentation de la distance du saut`)
|
||||
3. Pousser votre branche (`git push` dans un terminal ou via interface git)
|
||||
4. Créer une demande de modification dans Gitea
|
||||
4. Créer une demande de modification dans Gitea en suivant [ce lien](https://git.zacharie-guet.fr/zacharie/seeding-planets/pulls), cliquez sur Demande d'ajout et renseignez comme suit
|
||||
- Fusionner dans `main`
|
||||
- Tirer les modification depuis votre branche
|
||||
- Cliquez sur "Nouvelle Demande d'ajout"
|
||||
- Editer le titre de la demande d'ajout ou laissez comme telle
|
||||
- Cliquez sur sur "Créer une demande d'ajout"
|
||||
5. Communiquez avec l'équipe sur cette demande d'ajout, et appliquer la si vous avez l'aval de tous le monde (ou du moins des concernés du changement), en cliquant sur "Rebaser et avancer rapidement"
|
||||
|
||||
> Pour actualiser votre dépôt local, replacez vous sur `main` et récupérer les nouvelles modifications
|
||||
|
||||
### Ajout de fichiers ou modification de fichiers binaires (image, son)
|
||||
|
||||
1. Placez vous sur la branche principale `main`
|
||||
1. Placez vous sur la branche `main` (`git checkout main` ou interface git) et récupérez les modification (`git pull` ou interface git)
|
||||
2. Après la modification conséquente, créer un commit. Les noms des commits sont écrits en français et peuvent commencer par l'identifiant du ticket concernant la modification (exemple: `#8 ajout des sprites des plantes`)
|
||||
3. Pousser votre modification (`git push` dans un terminal ou via interface git)
|
||||
|
||||
## Troubleshoot
|
||||
|
||||
### Fenêtre "File have been modified outisde Godot"
|
||||
### Sur Godot, fenêtre "File have been modified outside Godot"
|
||||
|
||||
Si une fenêtre apparait avec marqué "Les fichiers suivants sont plus récents sur le disque", la majorité du temps il est plus sage de cliquer sur "Recharger depuis le disque dur".
|
||||
Si une fenêtre apparait avec marqué "Les fichiers suivants sont plus récents sur le disque", la majorité du temps, il est plus sage de cliquer sur "Recharger depuis le disque dur".
|
||||
|
||||
Loading…
Reference in New Issue
Block a user