Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (39 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

57 lines (39 loc) · 1.49 KB
Raw

Contribution à ⋞Galactic-Shrine⋟ GsId

Merci de l’intérêt que vous portez à GsId.

GsId est un système d’identifiants 256 bits maintenu par ⋞Galactic-Shrine⋟, avec des implémentations C# et PHP synchronisées.

Prérequis de développement

C#

  • .NET SDK 8.0 ou version supérieure
  • Exécutez les tests depuis la racine du dépôt :
dotnet test csharp/GalacticShrine.GsId.sln

PHP

  • PHP 8.3 ou version supérieure
  • Composer 2
  • Exécutez les tests depuis le dossier php :
cd php
composer install
composer test

Règles de contribution

  • Garder un comportement synchronisé entre les implémentations C# et PHP.
  • Ne pas modifier les formats officiels N et D sans décision de version majeure.
  • Garder un stockage base de données déterministe : privilégier le format N et une casse fixe par application.
  • Ajouter ou mettre à jour les tests pour chaque changement de comportement.
  • Conserver la rétrocompatibilité des API publiques autant que possible pendant la série 1.x.

Versionnement

GsId suit le versionnement sémantique :

  • MAJOR : changements incompatibles d’API ou de format.
  • MINOR : fonctionnalités rétrocompatibles.
  • PATCH : corrections, CI, documentation, packaging et mises à jour de maintenance.

Pull requests

Avant d’ouvrir une pull request, assurez-vous que :

dotnet test csharp/GalacticShrine.GsId.sln
cd php
composer validate --strict
composer test

s’exécutent avec succès.