Skip to content

Workflow

Jump to bottom
Emmanuel Chateau edited this page Mar 20, 2014 · 7 revisions

Localisation du répertoire webapp

La localisation du répertoire webapp de BaseX est configurable en renseignant le contexte pour Jetty dans webapp/WEB-INF/web.xml.

Le même fichier de configuration détermine également le contexte pour les bases de données.

Vu la facilité de déployement de BaseX, il n'est pas évident qu'il soit plus aisé de gérer l'application dans un répertoire distinct. Cependant, cela peut présenter un intérêt pour gérer la webapplication dans un répertoire de sites web ou bien pour éviter d'avoir besoin de vider le répertoire webapp installé par défaut avec BaseX.

Installation avec Git

Installer BaseX avec Git

BaseX fait l'objet de mises à jour régulières. Pour pouvoir facilement mettre à jour la version installée, il peut être intéressant de travailler avec une version distribuée avec Git.

Toutefois, il ne semble pas que le compte GitHub de BaseX propose une version directement installable avec git sans avoir besoin de compiler les sources. En tous cas, le répertoire n'est pas à jour avec la dernière version.

Installer SynopsX comme sous-module avec Git

S'il était possible d'installer BaseX directement avec Git, il pourrait être intéressant de pouvoir déployer SynopsX en utilisant les sous-modules de git.

Chapitre consacré aux sous-modules dans le Git BooK.

Installer SynopsX avec Git

Telle qu'elle est actuellement proposée, l'installation de SynopsX avec Git impose de vider le contenu du répertoire webapp tel qu'il est installé par BaseX.

cd <path_to_basex>/webapp
rm -fr *
git clone https://github.com/ahn-ens-lyon/synopsx.git .

Pour conserver l'installation par défaut de BaseX, il peut être préférable de cloner le répertoire pour en copier le contenu dans webapp, y compris les fichiers cachés, en créant un fichier .gitignore qui restreigne le versionning au contenu de SynopsX.

Travailler avec Git

Branches de travail

On considère habituellement que la branche master est la branche stable.

On réalise les développements sur des branches de travail :

git checkout nom_de_branche

Contribuer au projet (contributeur externe)

L'information sur la contribution au projet est renseignées dans un fichier CONTRIBUTING.md à la racine du répertoire.

Nous aimons les "pull requests". Voici un guide rapide pour contribuer :

Forkez le répertoire

[voir si nous décidons quelque chose pour implémenter des tests de développement]

Faîtes un "push" vers votre "fork" et soumettez un "pull request".

À partir de ce moment, vous allez devoir nous attendre. Nous essayerons au moins de commenter vos "pull requests" s'ils ne sont pas acceptés dans les trois jours ouvrables. Il est possible que nous suggérions quelques changements, améliorations ou alternatives.

Voici plusieurs éléments pour augmenter les chances que votre pull request soit accepté :

[ guidelines sur

  • convention de nommage (fichiers, fonctions, variables) documentation
  • indentation
  • ligne blanche sans espaces a = b pas a=b Suivre en général les conventions que vous trouverez dans les fichiers ! ]

cf. https://github.com/blog/1184-contributing-guidelines

< Retour

Clone this wiki locally