From e3e98321826dc386b855b562783c1eec6d632334 Mon Sep 17 00:00:00 2001
From: Xymorot <xymorot@mailbox.org>
Date: Tue, 2 Jul 2019 21:44:13 +0200
Subject: [PATCH] doc: update README with conventional commits info

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2854f3f..f739910 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,24 @@
 ## Development
 
+### Quickstart
+
 - `npm install`, the postinstall runs
   - `npm run rebuild`
     - might need to install some build tools depending on your platform
   - `npm run typeorm:migrate` for installing the database
 - `npm run tsc` for backend
 - `npm run webpack` for frontend
-- `npm dev`
+- `npm run dev`
+
+### Git Commits
+
+This project uses [Conventional Commits](https://www.conventionalcommits.or) with the following types:
+- `feat`: features, if any part of your commit implements a new function, use this
+- `fix`: bugfixes
+- `doc`: documentation
+- `refactor`: code refactoring
+
+Always try to split up your changes into coherent commits, a single commit should do a single thing.
 
 ### Database Migrations