CONTRIBUTING.jp.md

⋞Galactic-Shrine⋟ GsId への貢献

GsId への貢献に関心をお寄せいただき、ありがとうございます。

GsId は、⋞Galactic-Shrine⋟ によって保守されている 256 ビット識別子システムであり、C# と PHP の実装が同期されています。

開発要件

C#

• .NET SDK 8.0 以上
• リポジトリのルートからテストを実行してください。

dotnet test csharp/GalacticShrine.GsId.sln

PHP

• PHP 8.3 以上
• Composer 2
• php ディレクトリからテストを実行してください。

cd php
composer install
composer test

貢献ルール

• C# と PHP の実装の動作を同期させてください。
• 公式な N および D フォーマットは、メジャーバージョンの決定なしに変更しないでください。
• データベース保存は決定的である必要があります。アプリケーションごとに固定された大文字小文字と、N フォーマットの使用を推奨します。
• 動作変更ごとにテストを追加または更新してください。
• 可能な限り、1.x 系では公開 API の後方互換性を維持してください。

バージョニング

GsId はセマンティックバージョニングに従います。

• MAJOR: API またはフォーマットに対する互換性のない変更
• MINOR: 後方互換性のある機能追加
• PATCH: 修正、CI、ドキュメント、パッケージング、および保守更新

プルリクエスト

プルリクエストを作成する前に、次のコマンドが正常に成功することを確認してください。

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