parent
5aa3cb2849
commit
ef8536720b
|
|
@ -1,25 +1,26 @@
|
|||
|
||||
# Table of Contents
|
||||
|
||||
1. [Guide de contribution et de développement du serveur NALC](#orgbc846ec)
|
||||
1. [Créer son compte gitea](#orgf505339)
|
||||
2. [Créer des tickets de bugs](#org505f275)
|
||||
1. [Où poster les tickets](#orgb2de620)
|
||||
3. [Créer et installer **sa** version de NALC](#org54f1155)
|
||||
1. [Bifurquer les dépôts essentiels de NALC](#orgbe86683)
|
||||
2. [Cloner votre bifurcation du dépot nalc-server](#org6c07437)
|
||||
3. [Faire l'installation du serveur avec vos dépôts](#org0796781)
|
||||
4. [Configuration de fichiers](#org6aa4c3a)
|
||||
5. [Désactiver le mod irc et irc<sub>commands</sub>](#org4f489b2)
|
||||
6. [Changer le backend de la map (optionnel)](#org4b86e1d)
|
||||
4. [Lancer le serveur](#org5b5960a)
|
||||
1. [Manière classique](#orgf154a06)
|
||||
2. [Avec shutdown.sh](#orgd93ab18)
|
||||
5. [Proposer vos modifications](#orgb63bed0)
|
||||
1. [Modifier un mod](#org0f3f546)
|
||||
1. [Guide de contribution et de développement du serveur NALC](#orge3d42f8)
|
||||
1. [Créer son compte gitea](#orgbf0f248)
|
||||
2. [Créer des tickets de bugs](#org9adb9cd)
|
||||
1. [Où poster les tickets](#org02e4e87)
|
||||
3. [Créer et installer **sa** version de NALC](#org37a3efb)
|
||||
1. [Bifurquer les dépôts essentiels de NALC](#org60598a4)
|
||||
2. [Cloner votre bifurcation du dépot nalc-server](#org0ff8750)
|
||||
3. [Faire l'installation du serveur avec vos dépôts](#orgc10498c)
|
||||
4. [Configuration de fichiers](#orga72a195)
|
||||
5. [Désactiver le mod irc et irc<sub>commands</sub>](#org66dff68)
|
||||
6. [Changer le backend de la map (optionnel)](#orgb682e4b)
|
||||
4. [Lancer le serveur](#orgdaed5b4)
|
||||
1. [Manière classique](#org02ece4f)
|
||||
2. [Avec shutdown.sh](#org2184c29)
|
||||
5. [Proposer vos modifications](#orga21fe3d)
|
||||
1. [Modifier un mod](#org1e03750)
|
||||
2. [Proposer une demande d'ajout (Pull Request)](#org908c02f)
|
||||
|
||||
|
||||
<a id="orgbc846ec"></a>
|
||||
<a id="orge3d42f8"></a>
|
||||
|
||||
# Guide de contribution et de développement du serveur NALC
|
||||
|
||||
|
|
@ -30,7 +31,7 @@
|
|||
Pour les exemples donnés dans le guide nous serons l'utilisateur Sam.
|
||||
|
||||
|
||||
<a id="orgf505339"></a>
|
||||
<a id="orgbf0f248"></a>
|
||||
|
||||
## Créer son compte gitea
|
||||
|
||||
|
|
@ -40,7 +41,7 @@ Pour commencer, créez-vous un compte sur le serveur de dépôts git que je met
|
|||
Une fois inscrit vous pouvez vous connecter et ainsi commencer votre participation.
|
||||
|
||||
|
||||
<a id="org505f275"></a>
|
||||
<a id="org9adb9cd"></a>
|
||||
|
||||
## Créer des tickets de bugs
|
||||
|
||||
|
|
@ -48,7 +49,7 @@ Si vous constatez un bug sur le serveur NALC vous pouvez déjà le rapporter dir
|
|||
Pour ceux voulant contribuer de façon plus pointue, ou pour les personnes déjà contributrices en développement ou voulant le devenir, poster des tickets de bugs directement depuis l'interface de Gitea sera plus approprié et confortable.
|
||||
|
||||
|
||||
<a id="orgb2de620"></a>
|
||||
<a id="org02e4e87"></a>
|
||||
|
||||
### Où poster les tickets
|
||||
|
||||
|
|
@ -56,7 +57,7 @@ Pour des raisons pratiques les tickets concernants un bug du jeux ou qui semble
|
|||
Pour les bugs qui concernent la gestion ou l'administration de serveur en lui-même (exemple : un bug avec le script d'installation) vous devrez les poster dans le dépôt [nalc-server](https://sys4.fr/gitea/nalc/nalc-server/issues) de l'organisation [Notre Ami Le Cube](https://sys4.fr/gitea/nalc).
|
||||
|
||||
|
||||
<a id="org54f1155"></a>
|
||||
<a id="org37a3efb"></a>
|
||||
|
||||
## Créer et installer **sa** version de NALC
|
||||
|
||||
|
|
@ -64,7 +65,7 @@ Ici sera décrite l'installation du serveur avec l'intention de pouvoir proposer
|
|||
Si vous êtes juste curieux et souhaitez tester la version de développement officielle sans vouloir apporter de modifications, reportez-vous au guide d'administration du serveur qui contient un chapitre sur l'installation du serveur.
|
||||
|
||||
|
||||
<a id="orgbe86683"></a>
|
||||
<a id="org60598a4"></a>
|
||||
|
||||
### Bifurquer les dépôts essentiels de NALC
|
||||
|
||||
|
|
@ -84,7 +85,7 @@ Vos dépôts biffurqués (en tant qu'utilisateur Sam) seront accessibles à ces
|
|||
- <https://sys4.fr/gitea/Sam/nalc_game.git>
|
||||
|
||||
|
||||
<a id="org6c07437"></a>
|
||||
<a id="org0ff8750"></a>
|
||||
|
||||
### Cloner votre bifurcation du dépot nalc-server
|
||||
|
||||
|
|
@ -94,7 +95,7 @@ Ouvrez un terminal bash depuis votre ordinateur puis faite un clone du dépôt q
|
|||
$ git clone https://sys4.fr/gitea/Sam/nalc-server.git
|
||||
|
||||
|
||||
<a id="org0796781"></a>
|
||||
<a id="orgc10498c"></a>
|
||||
|
||||
### Faire l'installation du serveur avec vos dépôts
|
||||
|
||||
|
|
@ -104,7 +105,7 @@ Toujours depuis votre terminal, faire l'installation de la branche dev du serveu
|
|||
$ ./install.sh --url https://sys4.fr/gitea/Sam dev
|
||||
|
||||
|
||||
<a id="org6aa4c3a"></a>
|
||||
<a id="orga72a195"></a>
|
||||
|
||||
### Configuration de fichiers
|
||||
|
||||
|
|
@ -137,7 +138,7 @@ Après l'installation il faut configurer quelques fichiers.
|
|||
Ce script en l'état ne permet de sauvegarder un serveur que si le backend utilisé est postgresql.
|
||||
|
||||
|
||||
<a id="org4f489b2"></a>
|
||||
<a id="org66dff68"></a>
|
||||
|
||||
### Désactiver le mod irc et irc<sub>commands</sub>
|
||||
|
||||
|
|
@ -157,7 +158,7 @@ Plus tard, si le fichier **world.mt** devait être régénéré pour une autre r
|
|||
Pour les réactiver il faudra simplement les supprimer du script puis éxécuter le script de nouveau comme précédemment.
|
||||
|
||||
|
||||
<a id="org4b86e1d"></a>
|
||||
<a id="orgb682e4b"></a>
|
||||
|
||||
### Changer le backend de la map (optionnel)
|
||||
|
||||
|
|
@ -170,7 +171,7 @@ Pour cela il faut lancer le script **upgrade.sh** de nouveau de la même manièr
|
|||
$ ./upgrade.sh -w nalc-dev -b dev -f worldmt
|
||||
|
||||
|
||||
<a id="org5b5960a"></a>
|
||||
<a id="orgdaed5b4"></a>
|
||||
|
||||
## Lancer le serveur
|
||||
|
||||
|
|
@ -178,7 +179,7 @@ Vous êtes prêt pour le démarrage du serveur.
|
|||
Vous pouvez le faire de deux manières. Soit de manière classique soit à l'aide du script **shutdown.sh**
|
||||
|
||||
|
||||
<a id="orgf154a06"></a>
|
||||
<a id="org02ece4f"></a>
|
||||
|
||||
### Manière classique
|
||||
|
||||
|
|
@ -188,7 +189,7 @@ Vous pouvez le faire de deux manières. Soit de manière classique soit à l'aid
|
|||
Pour arrêter le serveur il vous suffira de faire les touches **[CTRL+C]** du clavier.
|
||||
|
||||
|
||||
<a id="orgd93ab18"></a>
|
||||
<a id="org2184c29"></a>
|
||||
|
||||
### Avec shutdown.sh
|
||||
|
||||
|
|
@ -209,7 +210,7 @@ Pour arrêter le serveur :
|
|||
$ ./shutdown.sh
|
||||
|
||||
|
||||
<a id="orgb63bed0"></a>
|
||||
<a id="orga21fe3d"></a>
|
||||
|
||||
## Proposer vos modifications
|
||||
|
||||
|
|
@ -218,7 +219,7 @@ Au travers de l'exemple suivant, voici une méthode pour modifier un mod que vou
|
|||
Puis vous demanderez à ce que cette modification soit fusionnée dans le dépôt officiel de NALC avec la fonction **demande d'ajout** proposé par gitea. C'est l'équivalent des *Pull Requests* de GitHub.
|
||||
|
||||
|
||||
<a id="org0f3f546"></a>
|
||||
<a id="org1e03750"></a>
|
||||
|
||||
### Modifier un mod
|
||||
|
||||
|
|
@ -303,6 +304,10 @@ Puis vous demanderez à ce que cette modification soit fusionnée dans le dépô
|
|||
|
||||
gauges, item_drop, maptools, nether
|
||||
lines 1-13/13 (END)
|
||||
|
||||
Et enfin pousser le commit (push) pour synchroniser le serveur.
|
||||
|
||||
$ git push
|
||||
|
||||
4. Modifier le mod
|
||||
|
||||
|
|
@ -433,5 +438,32 @@ Puis vous demanderez à ce que cette modification soit fusionnée dans le dépô
|
|||
|
||||
Voilà vos modifications sont bel et bien publiées et de façon correcte sur le serveur git.
|
||||
|
||||
6. Proposer une demande d'ajout (Pull Request)
|
||||
|
||||
<a id="org908c02f"></a>
|
||||
|
||||
### Proposer une demande d'ajout (Pull Request)
|
||||
|
||||
Maintenant vous vous dites que votre contribution vaudrait le coup d'être proposée au mainteneur du serveur NALC officiel pour qu'elle soit appréciée par le plus grand nombre.
|
||||
|
||||
Voici comment proposer vos modifications en créant une demande d'ajout au mainteneur du dépôt officiel pour qu'il puisse les fusionner s'il est d'accord.
|
||||
|
||||
Les demandes d'ajouts que vous proposerez ne doivent pas concerner le dépôt nalc-server-mods mais bien ses sous-modules, donc les mods eux-mêmes directement.
|
||||
Il serait trop compliqué d'expliquer exactement pourquoi ici mais c'est un sujet qui peut être discuté sur le salon irc #NALC-DEV du serveur par exemple.
|
||||
|
||||
Prenons l'exemple du mod riesenpilz que vous avez modifié précedement.
|
||||
Lors de son push vous aurez peut-être remarqué le message suivant :
|
||||
|
||||
remote: Create a new pull request for 'Sam:master':
|
||||
remote: https://sys4.fr/gitea/nalc/riesenpilz/compare/master...Sam:master
|
||||
|
||||
En fait, une demande d'ajout a été créé automatiquement pour fusionner vos modifications au dépôt d'origine de votre fork.
|
||||
Mais vous devez valider ce PR pour qu'il soit actif et que le mainteneur du dépôt d'origine soit prévenue. Pour cela, à l'aide de votre navigateur web, vous devez vous rendre à l'url indiqué soit : <https://sys4.fr/gitea/nalc/riesenpilz/compare/master...Sam:master>
|
||||
|
||||
Vous pouvez vous y rendre également en allant sur la page du dépôt d'origine (pas le vôtre, c'est important) puis aller à l'onglet demande d'ajouts.
|
||||
|
||||
Normalement la demande d'ajout devrait indiquer la fusion de la branche master de votre dépôt vers la branche master du dépôt d'origine.
|
||||
|
||||
Pour confirmer cette demande d'ajout, cliquer sur le bouton "Nouvelle demande d'ajout" puis remplissez le formulaire qui s'affiche pour rajouter une description à votre PR. Une discussion avec le mainteneur du dépôt cible pourra alors s'engager si il souhaite avoir des précisions ou faire des commentaires.
|
||||
|
||||
Ensuite libre à lui de fusionner votre PR ou non.
|
||||
En tout cas de votre côté vous avez finalisé votre demande d'ajout.
|
||||
Loading…
Reference in New Issue