From 63f22e1a526a3302762c29be3b03a5940d55ba7c Mon Sep 17 00:00:00 2001
From: Tilly Woodfield <22456167+tillywoodfield@users.noreply.github.com>
Date: Wed, 15 May 2024 11:11:47 +0300
Subject: [PATCH] docs(README): add contribution guidelines

---
 CONTRIBUTING.md | 25 +++++++++++++++++++++++++
 README.md       |  6 ------
 2 files changed, 25 insertions(+), 6 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..013d63b
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,25 @@
+# Contributing
+
+## How to contribute code
+
+### Commit messages
+
+This project uses [semantic-release](https://github.com/semantic-release/semantic-release) to automatically release when changes are merged to `main`.
+
+In order for this to work, commit messages must use [Angular Commit Message Conventions](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format), which in the simplest form looks like `<type>: <short summary>`. Below are some examples:
+
+- `feat: added new component`
+- `fix: fixed a bug`
+- `docs: updated documentation`
+
+If your change is a breaking change, this must be stated in the message, for example:
+
+```
+feat: updated some component
+
+BREAKING CHANGE: removes the '.subcomponent' class.
+```
+
+### What is a breaking change?
+
+A breaking change is any "incompatible API change". In the context of this design system, the API consists of CSS classes and SASS variables/functions/mixins etc. Any change which removes or renames a part of the API must be labelled a breaking change.
diff --git a/README.md b/README.md
index 18ac315..31b4ef1 100644
--- a/README.md
+++ b/README.md
@@ -22,12 +22,6 @@ Start storybook:
 npm start
 ```
 
-## Project Structure
-
-Sass code roughly follows [The 7-1 Pattern](https://sass-guidelin.es/#the-7-1-pattern).
-
-Storybook stories should be placed alongside their respective component.
-
 ## Production build
 
 Build CSS: