From ef938639c774769d795417b2d23468d52ff41414 Mon Sep 17 00:00:00 2001 From: Xymorot Date: Fri, 5 Jul 2019 22:56:43 +0200 Subject: [PATCH] doc: update commit documentation to better represent intent --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index baef467..4e93997 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,14 @@ ### 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 +- `feat`: features, if any part of your commit implements a new functionality, use this - `fix`: bugfixes -- `doc`: documentation - `refactor`: code refactoring -- `config`: changing configuration (linter, build process) -- `update`: updating dependencies and associated changes +- `update`: updating dependencies and associated code changes +- `doc`: documentation +- `config`: changing configuration (linters, build process) -Always try to split up your changes into coherent commits, a single commit should do a single thing. +Always try to split up your changes into coherent commits, a single commit should do a single thing. If your commit needs to do more than one thing it should be labeled with the type coming first in this list. ### Database Migrations