From 0101e023453c4ec113d131d82d9985cad932af3f Mon Sep 17 00:00:00 2001 From: Xymorot Date: Wed, 20 Nov 2019 23:29:58 +0100 Subject: [PATCH] doc: display commit types in a table with some better explanations --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 53b0349..cdb9ef8 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,17 @@ This project uses [Conventional Commits](https://www.conventionalcommits.or) with the following types: -- `feat`: features, if any part of your commit implements a new functionality or changes an existing one, use this -- `remove`: removal of existing code/functionality -- `fix`: bugfixes -- `refactor`: code refactoring -- `update`: updating dependencies and associated code changes -- `test`: any of the above, but with tests/mocks -- `config`: changing configuration (linters, build process) -- `doc`: documentation, including comments -- `reformat`: fixing code formatting +| type | description | +| ---------- | --------------------------------------------------------------------------------------- | +| `feat` | implementing a new feature or changes an existing one | +| `remove` | removing an existing feature | +| `fix` | repairing a feature which does not work correctly | +| `refactor` | reworking code so that its function does not change (but could have in unexpected ways) | +| `update` | updating dependencies and associated code changes | +| `test` | any of the above, but with tests/mocks | +| `config` | changing configuration (npm scripts, linters, build process) | +| `doc` | updating documentation, including code comments | +| `reformat` | rewriting code in a way in which it is impossible for function to change | 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.