CONTRIBUTING.md

< Back

Contributing to Ammolite

Thanks for your interest in contributing!

This is a guideline for contributing to Ammolite.

Before the Contribution

Please install the following dependencies:

Dependencies	Description
Node.js	JavaScript runtime
pnpm	Package manager for Node.js
just	Command runner
ls-lint	Linting tool for directories and files
typos-cli	Spell checker

Commands

The following commands are available:

Installing

This command will install Node.js dependencies.

just i

Default Command

This command will do linting, formatting and testing.

just

Linting

This command will lint the code.

just lint

Formatting

This command will format the code.

just fmt

Building

This command will build the code.

just build

Testing

This command will run all tests.

just test

Benchmarking

The following commands will run different benchmarks.

# Run variables benchmarks
just bench-var

# Run keyframes benchmarks
just bench-kf

# Run style benchmarks
just bench-style

# Run merge benchmarks
just bench-merge

# Run all benchmarks
just bench

Cleaning

This command will clean the unnecessary files.

just clean

This command will clean all unnecessary files including the node_modules directory.

just clean-all

Committing

When committing changes to the code, use the following prefixes:

• chore: updates in dependencies/tools
• build: changes to the build system
• fix: fixes a bug
• feat: adds a new feature
• refactor: other code changes
• perf: performance improvements
• security: security related changes
• style: style changes
• test: adding or updating tests
• docs: documentation only changes
• ci: CI configuration updates
• release: new version release

For example:

feat: add xxx feature
docs: fix typos