Bläddra i källkod

:memo: Add emoji section in git guide

In order to add emojis to visually categorize your commits.

That is only text in your commit message, and the display is pretty
welle handled by GitHub and Gogs.
DricomDragon 3 år sedan
förälder
incheckning
17278a2874
1 ändrade filer med 24 tillägg och 0 borttagningar
  1. 24 0
      Guides/git.md

+ 24 - 0
Guides/git.md

@@ -4,8 +4,32 @@ Useful git commands and workflow.
 
 ## Workflow
 
+### Branching model
+
 For a good workflow with branches, [see this article](https://nvie.com/posts/a-successful-git-branching-model/).
 
+### Commit
+
+Use emojis to categorize the commit.
+
+- :tada: `:tada:` | When you added a cool **new feature**.
+- :wrench: `:wrench:` | When you **tweaked** some parameters.
+- :recycle: `:recycle:` | When you **refactored** a part of the code.
+- :sparkles: `:sparkles:` | When you applied a **linter**.
+- :globe_with_meridians: `:globe_with_meridians:` | When you worked on **translations**.
+- :art: `:art:` | When you improved / added **grahics** assets like themes.
+- :lipstick: `:lipstick:` | When you worked on the **UI**.
+- :rocket: `:rocket:` | When you improved **performance**.
+- :memo: `:memo:` | When you wrote **documentation**.
+- :beetle: `:beetle:` | When you **fixed a bug**.
+- :revolving_hearts: `:revolving_hearts:` | When a new sponsor / contributor is added or credits are updated.
+- :heavy_check_mark: `:heavy_check_mark:` | When you worked on checks or adjusted the code to be compliant with them.
+- :twisted_rightwards_arrows: `:twisted_rightwards_arrows:` | When you **merged** a branch.
+- :fire: `:fire:` | When you **removed** something.
+- :truck: `:truck:` | When you **moved / renamed** something.
+
+Thanks for [Desktop-Cube author](git@github.com:Schneegans/Desktop-Cube.git) for the idea.
+
 ## Configuration
 
 `git config --global user.email "contact@jovian-hersemeule.eu"`