diff --git a/CONVENTIONAL_COMMITS.md b/CONVENTIONAL_COMMITS.md new file mode 100644 index 000000000..b6acfbb48 --- /dev/null +++ b/CONVENTIONAL_COMMITS.md @@ -0,0 +1,100 @@ +# Conventional Commits + +This project uses [Conventional +Commits](https://www.conventionalcommits.org/). Read the +[Summary](https://www.conventionalcommits.org/en/v1.0.0/#summary) or +the [Full +Specification](https://www.conventionalcommits.org/en/v1.0.0/#specification) +to learn more. + +## 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. |
+ |
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. |
+ |
| Labs | +sled-state-inspector |
+ About the sled-state-inspector project. |
+
| Continuous Integration | +xtask |
+ About the xtask project. |
+