Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 2.45 KB

Thank you for your interest in contributing to opensource COBOL 4J. A summary of how to contribute is below.

Issues

Although any topics related to opensource COBOL 4J can be posted in Issues, please submit ones written in English or Japanese.

Pull Requests

We will check pull requests that passed all CI checks running both tests and static code analysis. The static analysis checks whether C and Java source files are formatted using clang-format and google-java-format respectively, and whether PMD finds no error and warning in Java source files.

Before you submit pull requests, you should run ./format in order to format files in this repository.

The below sections describe how to setup and run static code analysis.

Setup Development Environment

We strongly recommend using Visual Studio Code with Dev Containers for a consistent development environment. Follow the steps below to set up your development environment.

  1. Install Docker on your machine.
  2. Install Visual Studio Code.
  3. Install the Remote - Containers extension in Visual Studio Code.
  4. Clone the repository.
  5. Open the repository in Visual Studio Code.
  6. Press Ctrl+Shift+P and Select Dev Containers: Reopen in Container.
  7. Wait for the DevContainer to start up and the build to complete. It may take several minutes to complete this process.
  8. (Optional) Press Ctrl+Shift+@ to open a new terminal of Visual Studio code.
  9. (Optional) Setup credentials for git.

Run static analysis

Caution

Since the behavior of these tools may differ from the one in other operatins systems, we recommend that you run ./format in Visual Studio Code with Dev Containers described in the previous section.

check with clang-format and google-java-format

Run ./format in the top directory of opensource COBOL 4J. If you want to make sure all files are formatted, run ./check-format in the top directory of opensource COBOL 4J.

PMD

Run the following command in libcobj/ directory:

./gradlew pmdMain