CONTRIBUTING.md

CONTRIBUTING to Wave Autoscale

• CONTRIBUTING to Wave Autoscale
  • Prerequisites
    • 1. Install Dependencies
    • 2. Prepare Environment
    • 3. Run
  • Coding Rules
    • Rust
      • Naming
  • Commit Message Conventions

Prerequisites

We have tested on MacOS and Linux. We are not sure if it works on Windows.

1. Install Dependencies

• Moonrepo >= 1.10.1
• Rust >= 1.70.0
• Node.js >= 18.14.0, NPM >= 10.2.3

If you are using Linux, you can install dependencies using the following commands.

apt-get update
apt-get install -y build-essential pkg-config libssl-dev

2. Prepare Environment

• Prepare Git Hooks

  $ moon sync hooks

3. Run

# Run Wave Autoscale in development mode
moon run controller:run

Coding Rules

Rust

Naming

• Use shared_ prefix for shared code.

  type shared_hashmap = Arc<Mutex<HashMap<String, String>>>;

Commit Message Conventions

• Use Conventional Commits for commit messages.
• type(group name): subject
• List of group names
  • controller (core/wave-autoscale)
  • api-server (core/api-server)
  • data-layer (core/data-layer)
  • utils (core/utils)
  • web-app (web/web-app)
  • moon (.moon)
  • github (.github)
  • docs (docs)
  • deployment (deployment)
  • example (example)
• Example

  feat(controller): add new feature
  fix(api-server): fix bug
  docs(.github): update docs
  chore(example): update build scripts
  refactor(utils): refactor code
  test(data-layer): add test