matrix-rust-sdk/CONVENTIONAL_COMMITS.md

Conventional Commits

This project uses Conventional Commits. Read the Summary or the Full Specification to learn more.

Types

Conventional Commits defines type (as in type(scope): message). This section aims at listing the types used inside this project:

Type	Definition
feat	About a new feature.
fix	About a bug fix.
test	About a test (suite, case, runner…).
docs	About a documentation modification.
refactor	About a refactoring.
ci	About a Continuous Integration modification.
chore	About some cleanup, or regular tasks.

Scopes

Conventional Commits defines scope (as in type(scope): message). This section aims at listing all the scopes used inside this project:

Group	Scope	Definition
Crates	sdk	About the matrix-sdk crate.
	appservice	About the matrix-sdk-appservice crate.
	base	About the matrix-sdk-base crate.
	common	About the matrix-sdk-common crate.
	crypto	About the matrix-sdk-crypto crate.
	indexeddb	About the matrix-sdk-indexeddb crate.
	qrcode	About the matrix-sdk-qrcode crate.
	sled	About the matrix-sdk-sled crate.
	store-encryption	About the matrix-sdk-store-encryption crate.
	test	About the matrix-sdk-test and matrix-sdk-test-macros crate.
Bindings	apple	About the matrix-rust-components-swift binding.
	crypto-nodejs	About the matrix-sdk-crypto-nodejs binding.
	crypto-js	About the matrix-sdk-crypto-js binding.
	crypto-ffi	About the matrix-sdk-crypto-ffi binding.
	ffi	About the matrix-sdk-ffi binding.
Labs	jack-in	About the jack-in project.
Continuous Integration	xtask	About the xtask project.

Generating CHANGELOG.md

The git-cliff project is used to generate CHANGELOG.md automatically. Hence the various cliff.toml files that are present in this project, or the package.metadata.git-cliff sections in various Cargo.toml files.

Its companion, git-cliff-action project, is used inside Github Action workflows.