Skip to content

contributing.md

Latest commit

 

History

History
186 lines (136 loc) · 5.65 KB

contributing.md

File metadata and controls

186 lines (136 loc) · 5.65 KB

Contributing to LatteArt

日本語版はこちらを参照して下さい。

Issues

Use Issues on GitHub.

Bug report

  • Use the template Bug report.
  • Apply the label bug to the issue.

Feature requests

  • Use the template Feature request.
  • Apply the label enhancement to the issue.

Questions

Use discussions feature of GitHub.

Development

LatteArt consists of the following packages:

Package Description
latteart-launch Command for launching
latteart-cli Web server for providing GUI
latteart-gui GUI (web application)
latteart-client Common front-end module
latteart-capture-cl Server for capturing browser interactions
latteart-repository Server for storing data

Each package of LatteArt works in cooperation as follows.

flowchart LR
  subgraph LatteArt
    launch(latteart-launch)
    subgraph latteart
      cli(latteart-cli)
      gui(latteart-gui)
      client(latteart-client)

      cli -- serve --> gui
      gui -- use --> client
    end
    capturecl(latteart-capture-cl)
    repository(latteart-repository)

    client -- HTTP --> capturecl
    client <-- WebSocket --> capturecl
    client -- HTTP --> repository

    launch -- exec process --> capturecl
    launch -- exec process --> cli
    launch -- exec process --> repository
  end

  driver(<b>Browser driver</b><br><i>eg. ChromeDriver</i>)
  classDef externals fill:#fbb,stroke:#f33
  class driver,browser externals

  capturecl <--> driver
Loading

Web API

Please refer to the following Web API when communicating with latteart-capture-cl and latteart-repository:

REST API Reference

💡 The above is the link to the latest version of the API reference. You can refer to past versions of the API reference by changing the main at the end of the URL to the release version (e.g., v2.15.2).

WebSocket API Reference

Development Environment Setup

Install the following software needed for development in your development environment:

  • Git
  • Node.js v22.13.1

Once you have installed everything, clone the latteart repository and run the following command:

$ cd latteart
$ npm install

Editor Setup

Install Visual Studio Code in your development environment.

After installation, double-click on latteart.code-workspace to open the workspace.

💡 If a popup appears recommending extensions, please install them as appropriate.

Commands to develop each package

See the respective package.json for the commands used to develop each package.

Build

To build the installation materials, run the following command to build all packages:

# for Windows
$ npm run package:win

# for Mac
$ npm run package:mac

This will create directories with the following structure under the dist directory:

# for Windows
dist/
  └─ package/
      └─ win/
          └─ latteart/
              ├─ latteart.bat
              ├─ launch.config.json
              ├─ launch.exe
              ├─ latteart/
              │   ├─ public/
              │   └─ latteart.exe
              ├─ latteart-capture-cl/
              │   └─ latteart-capture-cl.exe
              └─ latteart-repository/
                  ├─ history-viewer/
                  ├─ snapshot-viewer/
                  ├─ latteart-repository.exe
                  └─ latteart.config.json

# for Mac
dist/
  └─ package/
      └─ mac/
          └─ latteart/
              ├─ latteart.command
              ├─ launch.config.json
              ├─ launch
              ├─ latteart/
              │   ├─ public/
              │   └─ latteart
              ├─ latteart-capture-cl/
              │   └─ latteart-capture-cl
              └─ latteart-repository/
                  ├─ history-viewer/
                  ├─ snapshot-viewer/
                  ├─ latteart-repository
                  └─ latteart.config.json

Pull Requests

  • Create a pull request to merge code from your feature branch to the develop branch.
    • In principle, branch names should be feature/#[issue number]_[summary].
  • You must agree to DCO to contribute to LatteArt.
    • Add the following signature to the commit message to indicate that you agree with the DCO.
      • Signed-off-by: Random J Developer <random@developer.example.org>
        • Use your real name in the signature.
        • You need to set the same name in GitHub Profile.
        • git commit -s can add the signature.
  • Associate a pull request with the corresponding Issue.
    • If there is no corresponding issue, create a new one before creating a pull request.
  • Use the templates when creating a pull request.
  • The title of a pull request should include "fix" followed by the issue number and a summary of the pull request.
    • fix #[issue number] [summary]

Coding Style

  • Your code must pass the check by eslint.

Extension Development

By creating an extension, you can add your own features.