Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 2.5 KB
Raw

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

Issues

Although any topics related to Open COBOL ESQL 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 Scala source files are formatted using clang-format and Scalafmt respectively, and whether Scalastyle finds no error and warning in Java source files.

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 with git clone --recursive. Do not forget to specify --recursive.
  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.

Caution

In the dev container, Git Hooks executes code formatters when starting git commit command. It may take a minutes when you run git commit for the first time.

Run static analysis

Caution

CI executes formatters and static analysis tools in Almalinux 9. The behavior of these tools may differ from the one in other operatins systems.

check with clang-format and scalafmt

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