Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

54 lines (32 loc) · 2.28 KB
Raw

Contributing

These are the contribution guidelines for caterpillar.

Development takes place on GitHub at https://github.com/dvzrv/caterpillar.

Writing code

This project is written in Rust and formatted using the default rustfmt of the most recent version of Rust.

All contributions are linted using clippy and spell checked using codespell.

To aide in development, it is encouraged to use the local .ci/check.sh script as git pre-commit hook:

$ ln -f -s ../../.ci/check.sh .git/hooks/pre-commit

Writing commit messages

The commit message style follows conventional commits.

To aide in development, install cocogitto and add its git-hooks:

$ cog install-hook all

Creating releases

Releases are created by the developers of this project using cocogitto by running:

cog bump --auto

The above will automatically bump the version based on the commits since the last release, add an entry to CHANGELOG.md, create a tag, push the changes to the default branch of the project and create a release on https://crates.io.

License

All code contributions are dual-licensed under the terms of the Apache-2.0 and MIT.

All test environment scripts are licensed under the terms of the LGPL-3.0-or-later.

All documentation contributions fall under the terms of the CC-BY-SA-4.0.

All configuration file contributions fall under the terms of the CC0 1.0.

License identifiers and copyright statements are checked using reuse. By using .ci/check.sh as git pre-commit hook, it is run automatically.