CONTRIBUTING.md

Contributor's guide

Commit signing

Enable commit signing

git config commit.gpgsign true

Prerequisites

• Rust
• cargo deny
• typos
• cargo sort

Code quality assurance

Install a pre-push git hook:

git config core.hooksPath .githooks

Rust Documentation

The docs are available at the github page.

After cloning the repository, follow the instructions below to run the documentation locally:

RUSTDOCFLAGS="--html-in-header katex-header.html" cargo doc --workspace --all-features --no-deps

Docs for zip-plus:

RUSTDOCFLAGS="--html-in-header katex-header.html" cargo doc --no-deps -p zip-plus --open