Skip to content

betagouv/service-national-universel

Repository files navigation

Plateforme du Service National Universel

CI Test Coverage

Code source de la Plateforme du Service National Universel, organisé en plusieurs services :

Il est conseillé de lire le fichier README.md de chacun de ces services.

Installation et utilisation

Voir le README.md de chacun des services.

Pour run les principales app : npm i npm run dev

Pull Requests

Les pull requests sont toujours squashées dans main, il est donc particulièrement important de respecter la convention de nommage suivante: Pour une feature, préfixer par feat, pour un fix, par fix, suivi, entre parentheses, du domaine d'impact. Enfin, vous devez si il y en a un ajouter l'ID du ticket Notion.

Valeurs autorisées pour le préfixe: fix, feat, chore

Valeurs autorisées pour le domaine d'impact: admin, api, app, lib, misc

Exemples:

feat(api): 1789 - Chopping heads off.
fix(app, lib): 1794 - Corrected error with human rights.
chore(lib): Updating human rights package version to 2.0.

Branches

Le nom des branches doit toujours etre précédé par feat ou fix suivi de l'ID tu ticket Notion (si existant), il est possible d'ajouter une breve description. Si vous voulez qu'un environnement de test soit déployé avec la branche, il suffit de rajouter le suffixe -ci

Exemples:

feat-1789-chopping-heads-off
fix-1794-corrected-error-with-human-rights-ci
fix-1792-ci
fix-1792
fix-saving-the-day

Tests et déploiement

Main

La branche main ne doit contenir que des incréments qui ont été testés et validés, a chaque push, l'environnement d'intégration continueCI est redéployé.

Customs Envs

Il est possible et conseillé de déployer un environnement de test pour une Pull Request donnée, pour cela, le nom de la Pull Request doit etre suffixé avec -ci

Livraison

Les déploiements sont effectués de maniere hebdomadaire. Pour lancer un déploiement, créer une branche release-candidate via l'interface github. Sa création lancera le pipeline de déploiement basé sur les Github Actions.

Contact

Plus d'information sur la plateforme du Service National Universel et l'engagement civique ici : https://beta.gouv.fr/startups/snu.html

Pour contacter l’équipe: [email protected]