From 7620783abca910fc5df796f722709734a57a2d63 Mon Sep 17 00:00:00 2001 From: Daniel Thoren Date: Wed, 16 Dec 2020 10:16:33 +0100 Subject: [PATCH] :truck: move gitmoji doc to README.md --- README.md | 32 ++++++++++++++++++++++++++++++-- index.md | 29 ----------------------------- 2 files changed, 30 insertions(+), 31 deletions(-) delete mode 100644 index.md diff --git a/README.md b/README.md index aa664d1..e4c3828 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ -# gitmoji -Loosely based on [carloscuesta/gitmoji](https://github.com/carloscuesta/gitmoji) +## Welcome to DannyDannyDanny/gitmoji + + + Gitmoji + + +This gitmoji repo is focused on Python Data Processing based software engineering with a database. +To render emoji's view [index via GitHub version](https://github.com/DannyDannyDanny/gitmoji/blob/gh-pages/index.md). +In your commit message use the format `:gitmoji: commit message`. Avoid using multiple gitmojis. + +Missing a gitmoji? Get [inspiration](https://gist.github.com/rxaviers/7360908). +Submit an [issue](https://github.com/DannyDannyDanny/gitmoji/issues) (or PR). + +## `gitmoji` Lookup + +|emoji|code|description| +|---|---|---| +|:sparkles:|`:sparkles:`| add new feature / function| +|:goal_net:|`:goal_net:`| try/raise/handle errors or warnings| +|:zap:|`:zap:`| improve performance| +|:bug:|`:bug:`| fix this bug| +|:truck:|`:truck:`| moving / renaming | +|:recycle:|`:recycle:`| refactor code | +|:construction:|`:construction:`| work in progress | +|:white_check_mark:|`:white_check_mark:`| writing tests, running tests | +|:memo:|`:memo:`| doc / logging / verbosity / code comments | +|:fire:|`:fire:`| remove code / file | +|:alien:|`:alien:`| API and Database related work | +|:bar_chart:|`:bar_chart:`|Clean / transform / validate _data_| +dtho@netcompany.com diff --git a/index.md b/index.md deleted file mode 100644 index 146021e..0000000 --- a/index.md +++ /dev/null @@ -1,29 +0,0 @@ -## Welcome to DannyDannyDanny/gitmoji - - - Gitmoji - - -This gitmoji repo is focused on Python Data Processing based software engineering with a database. -To render emoji's view [index via GitHub version](https://github.com/DannyDannyDanny/gitmoji/blob/gh-pages/index.md). -In your commit message use the format `:gitmoji: commit message`. Avoid using multiple gitmojis. - -Missing a gitmoji? Get [inspiration](https://gist.github.com/rxaviers/7360908). -Submit an [issue](https://github.com/DannyDannyDanny/gitmoji/issues) (or PR). - -## `gitmoji` Lookup - -|emoji|code|description| -|---|---|---| -|:sparkles:|`:sparkles:`| add new feature / function| -|:goal_net:|`:goal_net:`| try/raise/handle errors or warnings| -|:zap:|`:zap:`| improve performance| -|:bug:|`:bug:`| fix this bug| -|:truck:|`:truck:`| moving / renaming | -|:recycle:|`:recycle:`| refactor code | -|:construction:|`:construction:`| work in progress | -|:white_check_mark:|`:white_check_mark:`| writing tests, running tests | -|:memo:|`:memo:`| doc / logging / verbosity / code comments | -|:fire:|`:fire:`| remove code / file | -|:alien:|`:alien:`| API and Database related work | -|:bar_chart:|`:bar_chart:`|Clean / transform / validate _data_|