/ Contributing

Thank you for your interest in MoPress! Whether you are reporting bugs, proposing features, improving documentation, contributing core features, or publishing plugins to the Plugins Hub, contributions are warmly welcomed.


Before starting development, ensure you have the following installed locally:

  • MoonBit: The latest MoonBit compiler and toolchain.

  • Bun (or Node.js): For running asset generators and external plugin protocol test suites.

  • Just: Command runner (recommended for running common tasks).

  • Git: Version control.

Caution

For MoonBit's native target on Windows, ensure the **MSVC** (Visual Studio C++ Build Tools) environment is installed and active.


git clone https://github.com/biyuehu/mopress.git
cd mopress

# Update MoonBit dependencies
moon update

# Install Git hooks (recommended)
just init

MoPress embeds default templates, static stylesheets, and demo projects directly into MoonBit source code (src/includes.mbt). Run prebuild after changing these assets:

just prebuild
# Equivalent to: bun scripts/gen-includes.ts

just test
# Equivalent to: just prebuild && moon test

MoPress has comprehensive unit and snapshot tests. If intentional changes affect snapshot outputs, update them with:

moon test --update

Before submitting code, ensure formatting and package interface declarations (.mbti) are updated:

moon fmt
moon info

  1. Create a feature branch from main: git checkout -b feat/my-feature

  2. Follow Conventional Commits for your commit messages (e.g. feat: ..., fix: ..., docs: ...).

  3. Ensure all tests pass (moon test) and moon fmt produces no uncommitted changes.