Auteur(s) FaVdB
CC-BY-SA
réalisé avec oStorybook 6.01a
Guide pour le contributeur au projet oStorybook
Sommaire
1. Introduction
1.1. Avant-propos
1.2. Rappel des objectifs de oStorybook
1.3. Rejoindre l'équipe
1.4. Structure du projet
2. Outils
2.1. Mailing-list
2.2. Netbeans
2.3. oStorybook
3. Dépots GIT
3.1. Droits d'accès
3.2. Usage
4. Support
4.1. Aide
4.2. Bugs et suivi
5. Site WEB
6. Documentation
7. Traduction
Ce guide est destiné aux contributeurs du projet oStorybook, qu'ils soient programmeurs ou pas. Il a pour objectif d'assurer une même base d'information à chacun. Il s'efforcera de présenter les différents outils employés et parfois le meilleur moyen de les utiliser.
Ce guide est loin d'être complet, certaines parties sont vides. N'hésitez pas à proposer vos suggestions.
Les développeurs potentiels ne doivent pas perdre de vue que oStorybook doit rester un outil d'aide à l'écriture, depuis l'idée initiale jusqu'à la publication de l'oeuvre.
Par ailleurs, oStorybook doit rester un Logiciel Libre, et, autant que possible, s'absetnir d'utiliser des API externes dont la licence d'usage n'est pas conforme à la GPL v2.
Pour rejoindre l'équipe de développement, soit en qualité de programmeur, soit en qualité de traducteur régulier, merci d'adresser un message à l'adresse dev @ ostorybook.eu (ne pas oublier d'enlever les espaces en copiant l'adresse)
Après un éventuel dialogue vous serez certainement accepté dans l'équipe qui suppose une inscription à une ou deux listes de diffusion. La liste "dev" (pour développement) est relativement active (environ 2 à 3 messages par semaine, plus en période intensive de développement, surtout en période de validation d'une nouvelle version). La liste "i18n" (pour la traduction) est beaucoup moins active.
N'oubliez pas de préciser votre domaine de compétence (programmation Java, traduction en précisant la langue, écriture de documentation, etc...).
Comme indiqué au 1.3. Rejoindre l'équipe les listes de diffusion sont :
L'inscription à ces listes n'est pas libre, vous devez en faire la demande auprès à l'adresse de contact.
L'outil privélégié pour le développement, en tant qu'interface de développement, est Apache-Netbeans. Toutefois, vous pouvez utiliser l'interface de votre choix après validation de l'équipe de développement.
oStorybook utilise plusieurs API externes dont un version ZIP est téléchargeable.
Dans le cadre du projet oStorybook plusieurs outils spécifiques sont développés :
En règle général ces outils sont intégrés à oStorybbok, mais ils peuvent aussi être utilisés de manière indépendante.
L'outil de gestion des versions et du développement est basé sur GitLab et hébergé sur le site Framagit.fr. Pour avoir accès au serveur vous devrez y créer votre compte puis signaler cette création à l'équipe de développement de manière à obtenir les droits d'accès nécessaires.
En cas de difficulté à utiliser oStorybook vous pouvez poser vos questions sur le forum d'aide. Vous pourrez aussi y suggérer vos améliorations.
Pour intervenir sur le forum il sera nécessaire de créer un compte vous y autorisant (voir le message en en-tête du site expliquant pourquoi cette création est obligatoire). Par ailleurs, lorsque vous avez créé un compte vous pourrez aussi souscrire à la "lettre d'information" (prévoir une diffusion lors de chaque nouvelle version, soit environ 3 fois par an).
L'outil de suivi des bugs (bugtracker) est basé sur Flyspray et dispose de son site indépendant, c'est pourquoi il vous faudra, là aussi, vous y créer un compte.