Open COBOL ESQL 4Jへのコントリビュートを検討頂きありがとうございます。 下記にコントリビュートの手順を示します。
Open COBOL ESQL 4Jに関するトピックをIssuesに投稿してください。ただし、英語か日本語での記載をお願いします。
CIはテストとコードの静的解析を実行します。 CIの静的解析はCとScalaのソースコードがそれぞれclang-format and Scalafmtで整形されているか、 ScalastyleによるScalaソースコードの静的解析でエラーや警告が表示されないかをチェックします。
下記にそれぞれのツールのセットアップと使用方法を説明します。
一貫した開発環境を確保するために、Visual Studio Code with Dev Containersの使用を強く推奨します。以下の手順に従って開発環境をセットアップしてください。
- Dockerをインストールします。
- Visual Studio Codeをインストールします。
- Visual Studio CodeにRemote - Containers拡張機能をインストールします。
git clone --recursiveコマンドを使ってリポジトリをクローンします。--recursiveを指定するのを忘れないでください。- Visual Studio Codeでリポジトリを開きます。
Ctrl+Shift+Pを押して、Dev Containers: Reopen in Containerを選択します。- DevContainerの起動とビルドが完了するまで待ちます。このプロセスは数分かかることがあります。
- （オプション）
Ctrl+Shift+@を押して、Visual Studio Codeの新しいターミナルを開きます。 - （オプション）gitの認証情報を設定します。
Caution
Dev container内では、Git Hooksがgit commitコマンドを開始する際にコードフォーマッタを実行します。初めてgit commitを実行する際には数分かかることがあります。
Caution
CIはAlmalinux 9でフォーマッタと静的解析ツールを実行します。これらのツールの動作は他のオペレーティングシステムとは異なる場合があります。
Open COBOL ESQL 4Jのトップディレクトリで./formatを実行してください。
./check-formatを実行することで、フォーマットが完了したかを確認できます。