CONTRIBUTING.md

Development Guide

Requirements

Toolchain	Version
Rust	^1.74.0
just	^1.36.0

Workflow

Download source code

git clone https://github.com/Nugine/zuc.git
cd zuc

Run basic checks and tests

just dev

Open documentation

just doc

Run CI checks locally

just ci

Git

Commit Message

We follow the Conventional Commits specification.

Pull Request

Before creating or updating a pull request, please make sure to run the following commands and resolve any warnings or errors:

just dev