Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.82 KB

CONTRIBUTING_JP.md

File metadata and controls

47 lines (32 loc) · 2.82 KB

opensource COBOL 4Jへのコントリビュートを検討頂きありがとうございます。 下記にコントリビュートの手順を示します。

Issues

opensource COBOL 4Jに関するトピックを投稿してください。ただし、英語か日本語での記載をお願いします。

Pull Requests

CIはテストとコードの静的解析を実行します。 CIの静的解析はCとJavaのソースコードがそれぞれclang-format and google-java-formatで整形されているか、 PMDによるJavaソースコードの静的解析でエラーや警告が表示されないかをチェックします。

Pull Request提出時には、./formatを実行してリポジトリ内のコードをフォーマットしてください。

下記にそれぞれのツールのセットアップと使用方法を説明します。

開発環境のセットアップ

一貫した開発環境を確保するために、Visual Studio Code with Dev Containersの使用を強く推奨します。以下の手順に従って開発環境をセットアップしてください。

  1. Dockerをインストールします。
  2. Visual Studio Codeをインストールします。
  3. Visual Studio CodeにRemote - Containers拡張機能をインストールします。
  4. リポジトリをクローンします。
  5. Visual Studio Codeでリポジトリを開きます。
  6. Ctrl+Shift+Pを押して、Dev Containers: Reopen in Containerを選択します。
  7. DevContainerの起動とビルドが完了するまで待ちます。このプロセスは数分かかることがあります。
  8. （オプション）Ctrl+Shift+@を押して、Visual Studio Codeの新しいターミナルを開きます。
  9. （オプション）gitの認証情報を設定します。

静的解析の実行

Caution

これらのツールの動作は他のオペレーティングシステムとは異なる場合があります。上記のVisual Studio Code with Dev Containersの環境でフォーマッタを実行することを推奨します。

clang-formatとgoogle-java-format

opensource COBOL 4Jのトップディレクトリで./formatを実行してください。 ./check-formatを実行することで、フォーマットが完了したかを確認できます。

PMD

opensource COBOL 4Jのlibcobj/ディレクトリで下記のコマンドを実行してください。

./gradlew pmdMain