theoludwig/p61-project
Archived
1
1
Fork 0
Code Issues Pull Requests Releases Activity
This repository has been archived on 2024-11-20. You can view files and clone it, but cannot push or open issues or pull requests.
dfcddb5f3a
p61-project/docs/CONVENTIONS.md

1.6 KiB
Raw Blame History

Conventions développement informatique

Linting/Formatting/Tests

Le code est formaté grâce à Prettier et vérifié grâce à ESLint et à TypeScript pour s'assurer que le code respecte les bonnes pratiques de développement, et détecter en amont les possibles erreurs.

Nous utilisons également Jest pour les tests automatisés.

# Lint
npm run lint:prettier
npm run lint:eslint
npm run lint:typescript

# Test
npm run test

Une pipeline CI (.gitlab-ci.yml) est en place pour vérifier que le code respecte ces bonnes pratiques et que les tests passent.

GitFlow

Le projet suit la convention GitFlow reposant sur 2 branches principales:

  • main (ou master): Contient le code de la dernière version stable et déployé en production.
  • develop: Contient le code en cours de développement. Les nouvelles fonctionnalités et les correctifs de bugs sont fusionnés ici.

Convention des commits

Les commits respectent la convention Conventional Commits et Semantic Versioning pour la gestion des versions et des releases en fonction des commits.

Les commits doivent être atomiques c'est à dire qu'il respecte 3 règles:

  • Ne concerne qu'un seul sujet (une fonctionnalité, une correction de bug, etc.)
  • Doit avoir un message clair et concis
  • Ne doit pas rendre de dépôt "incohérent" (bloque la CI du projet)