https://sourceforge.net/p/the-event/wiki/Guide%2520Maintenance/Recent changes to Guide MaintenanceenWed, 13 Jan 2021 07:40:14 -0000https://sourceforge.net/p/the-event/wiki/Guide%2520Maintenance/<div class="markdown_content"><pre></pre> </div>Lucas JEANPIERREWed, 13 Jan 2021 07:40:14 -0000https://sourceforge.net7a3666fdd0510319d578bf119fbfa8db40caa4e1https://sourceforge.net/p/the-event/wiki/Maintenance/<div class="markdown_content"><h1 id="maintainers">Maintainers</h1> <p>Ce fichier est destiné aux mainteneurs du projet.</p> <h2 id="prerequis">Prérequis</h2> <p>Des dépendances de développement sont nécéssaire pour participer au projet.<br/> Vous pouvez les installer avec :</p> <div class="codehilite"><pre><span></span>npm install --target<span class="o">=</span>dev </pre></div> <h2 id="structure-du-projet">Structure du projet</h2> <p>Ce projet est structuré selon une certaine architecture qui sépare source et<br/> documentation tel que :</p> <ul> <li><code>doc</code> : documentation</li> <li><code>src</code> : code source</li> <li><code>__tests__</code> : tests unitaires</li> <li><code>model</code> : structures de données</li> <li><code>parser</code> : outils pour parser les données en entrée</li> <li><code>spec</code> : fonctionnalité élémentaires</li> <li><code>UIConsult.js</code> : fichier principal du projet</li> <li><code>var</code> : données utiles pour le programme et données en sortie</li> <li><code>LICENCE</code> : Licence</li> <li><code>README.md</code> : Presentation du projet</li> </ul> <h2 id="documentation-du-projet">Documentation du projet</h2> <p>Chaque fonction / classe / methode doit être documentée afin que tout le monde<br/> puisse participer au projet. On utilise pour cela la <a class="" href="https://jsdoc.app/" rel="nofollow">JsDoc</a>.</p> <h2 id="ajout-et-modifications-de-fonctionnalites">Ajout et modifications de fonctionnalités</h2> <p>Chaque spécifications du programme ont été codés dans le répertoire <code>src/spec</code><br/> et dans le fichier <code>src/UIConsult.js</code>.</p> <p>Le fichiers contenus dans <code>src/spec</code> sont purement la fonctionnalité sans entrées<br/> utilisateur ni sortie, mais seulement une valeur de retour qui est le résultat.</p> <p>Ce résultat sera traité et affiché dans la commande correspondant définie dans le<br/> fichier <code>src/UIConsult.js</code> : on y traite les entrées et les sorties du programme<br/> dans la console.</p> <h2 id="tests-unitaires">Tests unitaires</h2> <p>Les tests unitaires sont rédigés avec la librairie <a class="" href="https://www.npmjs.com/package/jest" rel="nofollow">Jest</a><br/> et sont situés dans le dossier <code>src/__tests__/</code>.</p> <p>Chaque fichier de test doit contenir au minimum une suite de test, et chaque suite de test doit<br/> aussi contenir au minimum 2 tests.</p> <h3 id="prerequis-pour-lancer-les-tests">Prérequis pour lancer les tests</h3> <p>Il faut installer les librairies de développement (cf. Maintainers#Prérequis).</p> <h3 id="lancement-des-tests-unitaires">Lancement des tests unitaires</h3> <p>Pour lancer les tests, il y a deux possibilités :</p> <div class="codehilite"><pre><span></span>npm <span class="nb">test</span> <span class="c1"># Ou</span> npx jest </pre></div> <h2 id="tickets">Tickets</h2> <p>Chaque tickets pour les <code>issues</code> doivent contenir :</p> <ul> <li>Un titre explicite</li> <li>Une description succinte et complète.</li> <li>Un manuel pour reproduire le bug</li> <li>Le résultat obtenu et le résultat attendu</li> <li>Les informations de l'environnement d'execution</li> <li>Des fichiers de données en exemple si possible</li> </ul> <p>Chaque tickets pour les <code>enchancements</code> doivent contenir :</p> <ul> <li>Un titre clair et explicite</li> <li>Une description succinte et complète de la fonctionnalité</li> <li>Donner plusieurs exemples de résultats avec des exemples de données en entrée</li> <li>Les informations de l'environnement d'execution de la future fonctionnalité</li> <li>Des fichiers de données en exemple si possible</li> </ul></div>Lucas JEANPIERREWed, 13 Jan 2021 07:29:25 -0000https://sourceforge.net5e10818b865e5dde4da3e26c069264c4da816641