diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 831934a..bd1d000 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -87,33 +87,40 @@ Sur le [menu Pull requests](https://gitbucket.inist.fr/tdm/web-services/pulls) de GitBucket cliquez sur `New pull request` (en haut à droite de la page). -![bouton de création d'une PR](images/pull-request-button.png) +> ![bouton de création d'une PR](images/pull-request-button.png) Si vous ne voyez pas le bouton, connectez-vous à GitBucket. -![bouton de connexion](images/gitbucket-signin.png) +> ![bouton de connexion](images/gitbucket-signin.png) Par défaut, on tombe sur une page comparant la branche `master` à... la branche `master`. -![Comparaison par défaut](images/pull-request-default.png) +> ![Comparaison par défaut](images/pull-request-default.png) Comme vous avez déjà poussé votre branche, vous pouvez la sélectionner (à droite): -![Page de création de PR](images/pull-request-creation.png) +> ![Page de création de PR](images/pull-request-creation.png) Il est important de donner un titre et une description parlante à votre *pull request*, c'est ce qui permettra de la retrouver facilement. En général, le titre est lié au nom de la branche, si on a été bien inspiré en créant la branche. -![formulaire de description de la PR](images/pull-request-description.png) +> ![formulaire de description de la PR](images/pull-request-description.png) Comme la *pull request* est dédié à la communication entre nous, on peut y écrire en français (dans un projet *open source* classique, on préfère utiliser l'anglais). -![PR créée](images/pull-request-created.png) +> ![PR créée](images/pull-request-created.png) + +Il ne reste plus qu'à continuer à travailler dans la branche de la *pull +request*, en n'oubliant pas de pousser régulièrement les *commits* sur le dépôt. + +```bash +git push +``` ### Nouvelle instance ? @@ -150,21 +157,42 @@ ### examples.http -### Tester le swagger - ## Déploiement ### Tester sur la vi -- service -- www-home +#### Déployer le service sur la vi + +La version de la branche. + +#### Tester le swagger + +#### www-home + +Si c'est une nouvelle instance, l'ajouter dans le `index.html` de `www-home`, +qui sera `openapi.services.inist.fr`. + +### Code review + +### Merge vers master + +### Faire une version ### Vérifier l'utilisation (grafana) ### Déployer sur la vp +La version générée `instance@version`. + ## Après le déploiement +### Vérifier que le swagger fonctionne + +Si c'est une nouvelle instance, il se peut qu'elle n'apparaisse pas +immédiatement dans `openapi.services.inist.fr`, car ce site est mise à jour +automatiquement toutes les demi-heures (pendant les heures de bureau, les jours +de semaine). + ### catalogues LODEX ### Objectif TDM