Userscripts/Contributeurs

Si vous vous retrouvez ici c'est probablement que vous désirez en savoir plus sur la manière dont la librairie DreadCast-Lib est produite voir que vous souhaitez également vous joindre au projet.<br\> Commençons donc par le commencement.

Outils

GitHub

Par soucis de simplicité, le projet est entièrement hébergé sur GitHub. <br\> Il est donc nécessaire pour la suite de vous y inscrire. Une fois fait, rendez cous à l'adresse du projet.<br\> Puis cliquez sur fork en haut à droite.<br\> Vous pouvez maintenant éditer les sources depuis votre propre dépôt GitHub ou sur votre machine.<br\><br\> Les outils présenté ici nécessitent de savoir utiliser l'invite de commandes des deux systèmes suivant :

Windows

Git

L'installation de Git se fait au travers de msysgit. <br\>

Grunt

Pour Grunt, cela ce fait en deux étapes. <br\> Il faut tout d'abord installer NodeJS. <br\> Puis après avoir ouvert votre invite de commandes en mode administrateur exécutez la commande suivante :

npm install -g grunt

Linux

Git

L’installation de Git sous linux se fait à l'aide du paquet "git-core".<br\> Une doc est disponible ici bien que je détaillerais plus bas les seuls commandes utiles au projet.

Grunt

Pour Grunt, c'est un petit peu plus compliqué. <br\> Vous devez dans un premier temps installer "NodeJs et npm". <br\> Puis installer le module GruntJS : (necessite d'être root)

npm install -g grunt

Utilisation

Git

Après avoir lancé Git (windows) / Terminal (linux) rendez vous dans le dossier censé accueillir votre travail.

cd /adresse/du/dossier/
ou
cd lecteur:\adresse\du\dossier

<br\> Il est maintenant temps de récupérer les sources sur votre machine. Rien de plus simple, la commande fait référence à git puis à la fonction clone soit :

git clone https://github.com/VOTRE-PSEUDO/DreadCast-Lib.git

<br\> Vous allez maintenant travailler sur votre propre version du projet.<br\> Mais il vous faut pouvoir vous tenir informé de l'avancé du projet principal.<br\> On va donc créer un pointeur vers celui ci.

git remote add upstream https://github.com/Swizz540/DreadCast-Lib.git
git fetch upstream

<br\> Vous disposez maintenant de deux pointeurs.

1. origin <br\> Créé par défaut, il s'agit de votre dépôt sur GitHub.
2. upstream <br\> Maintenant créé, c'est le dépôt principal du projet.

<br\> Pour en récupérer les changements il suffit donc simplement de faire :

git fetch upstream
git merge upstream

Dans un premier temps, il va aller voir les différences entre le dépôt upstream et le votre.<br\> Puis intégrer les nouveauté dans les fichiers. <br\> Si le même fichier est modifier à la même ligne sur l'upstream et sur votre dépôt git peut soulever une erreur, décalez simplement d'une ligne votre nouvelle instruction. <br\><br\> [...] <br\><br\> Après avoir modifié les fichiers, il est maintenant temps de les partager. Avant toutes choses, il est nécessaire de référencer les changements à l'aide des deux commandes suivantes.

git add *
git commit -a

Un éditeur de texte apparaît, vous demandant d'entrer le plus clairement possible les changements effectué. Cela permettra aux autres contributeurs de comprendre vos modifications. <br\> Maintenant fait, il ne vous reste plus qu'à le pousser sur votre dépôt public. (celui sur GitHub).

git push origin

<br\> <br\> Une fois fière de vos changement vous pouvez en informer les autres contributeurs. Il vous reste donc plus qu'à vous rendre sur la page principal du projet ou d'un autre contributeur.<br\> Puis de cliquer sur pull Request

Grunt

Grunt est un outil très puissant ayant plusieurs rôles nous en utiliserons que trois pour le moment.<br\> Il s'agit de :

1. lint <br\> Vérifie la syntaxe et les règles d'usage du langage.
2. qunit <br\> Vérifie l’exécution du code et l'utilisation des variables.
3. concat <br\> voir concaténation

<br\> L'ensemble de ses configurations sont contenu dans le fichier grunt.js, vous n'avez techniquement pas besoin d'y toucher.<br\> Il se base également sur les valeurs contenu dans le fichier package.json.<br\><br\> Il s'utilise simplement grâce à la commande :

grunt

Concaténation

C'est l'étape la plus importante du projet, celle qui permet d'assembler toutes les portions de codes en un seul et unique fichiers.<br\> Celui ci est contenu par défaut dans le fichier dreadcastlib-dev<version>.js. <br\><br\> Vous devez vous tenir en permanence de sont comportement de recherche dans l'élaboration de vos fichiers sources à fin de pouvoir être sur que ceux ci seront ajouté au fichier distribuable.<br\><br\> Celle ci est amené à changé en fonction de l’évolution du projet

• DreadCast-lib
  • src
    • init.js
    • misc.js
    • class
      • *.class.js