mirror of
https://github.com/LCTT/TranslateProject.git
synced 2024-12-26 21:30:55 +08:00
Merge pull request #12772 from MjSeven/20190218
翻译完成 20190218 Emoji-Log
This commit is contained in:
Xingyu.Wang
GitHub
commit
10057dfecf
@ -1,176 +0,0 @@
|
||||
[#]: collector: (lujun9972)
|
||||
[#]: translator: (MjSeven)
|
||||
[#]: reviewer: ( )
|
||||
[#]: publisher: ( )
|
||||
[#]: url: ( )
|
||||
[#]: subject: (Emoji-Log: A new way to write Git commit messages)
|
||||
[#]: via: (https://opensource.com/article/19/2/emoji-log-git-commit-messages)
|
||||
[#]: author: (Ahmad Awais https://opensource.com/users/mrahmadawais)
|
||||
|
||||
Emoji-Log: A new way to write Git commit messages
|
||||
======
|
||||
Add context to your commits with Emoji-Log.
|
||||
|
||||
|
||||
I'm a full-time open source developer—or, as I like to call it, an 🎩 open sourcerer. I've been working with open source software for over a decade and [built hundreds][1] of open source software applications.
|
||||
|
||||
I also am a big fan of the Don't Repeat Yourself (DRY) philosophy and believe writing better Git commit messages—ones that are contextual enough to serve as a changelog for your open source software—is an important component of DRY. One of the many workflows I've written is [Emoji-Log][2], a straightforward, open source Git commit log standard. It improves the developer experience (DX) by using emoji to create better Git commit messages.
|
||||
|
||||
I've used Emoji-Log while building the [VSCode Tips & Tricks repo][3], my 🦄 [Shades of Purple VSCode theme repo][4], and even an [automatic changelog][5] that looks beautiful.
|
||||
|
||||
### Emoji-Log's philosophy
|
||||
|
||||
I like emoji (which is, in fact, the plural of emoji). I like 'em a lot. Programming, code, geeks/nerds, open source… all of that is inherently dull and sometimes boring. Emoji help me add colors and emotions to the mix. There's nothing wrong with wanting to attach feelings to the 2D, flat, text-based world of code.
|
||||
|
||||
Instead of memorizing [hundreds of emoji][6], I've learned it's better to keep the categories small and general. Here's the philosophy that guides writing commit messages with Emoji-Log:
|
||||
|
||||
1. **Imperative**
|
||||
* Make your Git commit messages imperative.
|
||||
* Write commit message like you're giving an order.
|
||||
* e.g., Use ✅ **Add** instead of ❌ **Added**
|
||||
* e.g., Use ✅ **Create** instead of ❌ **Creating**
|
||||
2. **Rules**
|
||||
* A small number of categories are easy to memorize.
|
||||
* Nothing more, nothing less
|
||||
* e.g. **📦 NEW** , **👌 IMPROVE** , **🐛 FIX** , **📖 DOC** , **🚀 RELEASE** , and **✅ TEST**
|
||||
3. **Actions**
|
||||
* Make Git commits based on actions you take.
|
||||
* Use a good editor like [VSCode][7] to commit the right files with commit messages.
|
||||
|
||||
|
||||
|
||||
### Writing commit messages
|
||||
|
||||
Use only the following Git commit messages. The simple and small footprint is the key to Emoji-Logo.
|
||||
|
||||
1. **📦 NEW: IMPERATIVE_MESSAGE**
|
||||
* Use when you add something entirely new.
|
||||
* e.g., **📦 NEW: Add Git ignore file**
|
||||
2. **👌 IMPROVE: IMPERATIVE_MESSAGE**
|
||||
* Use when you improve/enhance piece of code like refactoring etc.
|
||||
* e.g., **👌 IMPROVE: Remote IP API Function**
|
||||
3. **🐛 FIX: IMPERATIVE_MESSAGE**
|
||||
* Use when you fix a bug. Need I say more?
|
||||
* e.g., **🐛 FIX: Case converter**
|
||||
4. **📖 DOC: IMPERATIVE_MESSAGE**
|
||||
* Use when you add documentation, like README.md or even inline docs.
|
||||
* e.g., **📖 DOC: API Interface Tutorial**
|
||||
5. **🚀 RELEASE: IMPERATIVE_MESSAGE**
|
||||
* Use when you release a new version. e.g., **🚀 RELEASE: Version 2.0.0**
|
||||
6. **✅ TEST: IMPERATIVE_MESSAGE**
|
||||
* Use when you release a new version.
|
||||
* e.g., **✅ TEST: Mock User Login/Logout**
|
||||
|
||||
|
||||
|
||||
That's it for now. Nothing more, nothing less.
|
||||
|
||||
### Emoji-Log functions
|
||||
|
||||
For quick prototyping, I have made the following functions that you can add to your **.bashrc** / **.zshrc** files to use Emoji-Log quickly.
|
||||
|
||||
```
|
||||
#.# Better Git Logs.
|
||||
|
||||
### Using EMOJI-LOG (https://github.com/ahmadawais/Emoji-Log).
|
||||
|
||||
|
||||
|
||||
# Git Commit, Add all and Push — in one step.
|
||||
|
||||
function gcap() {
|
||||
git add . && git commit -m "$*" && git push
|
||||
}
|
||||
|
||||
# NEW.
|
||||
function gnew() {
|
||||
gcap "📦 NEW: $@"
|
||||
}
|
||||
|
||||
# IMPROVE.
|
||||
function gimp() {
|
||||
gcap "👌 IMPROVE: $@"
|
||||
}
|
||||
|
||||
# FIX.
|
||||
function gfix() {
|
||||
gcap "🐛 FIX: $@"
|
||||
}
|
||||
|
||||
# RELEASE.
|
||||
function grlz() {
|
||||
gcap "🚀 RELEASE: $@"
|
||||
}
|
||||
|
||||
# DOC.
|
||||
function gdoc() {
|
||||
gcap "📖 DOC: $@"
|
||||
}
|
||||
|
||||
# TEST.
|
||||
function gtst() {
|
||||
gcap "✅ TEST: $@"
|
||||
}
|
||||
```
|
||||
|
||||
To install these functions for the [fish shell][8], run the following commands:
|
||||
|
||||
```
|
||||
function gcap; git add .; and git commit -m "$argv"; and git push; end;
|
||||
function gnew; gcap "📦 NEW: $argv"; end
|
||||
function gimp; gcap "👌 IMPROVE: $argv"; end;
|
||||
function gfix; gcap "🐛 FIX: $argv"; end;
|
||||
function grlz; gcap "🚀 RELEASE: $argv"; end;
|
||||
function gdoc; gcap "📖 DOC: $argv"; end;
|
||||
function gtst; gcap "✅ TEST: $argv"; end;
|
||||
funcsave gcap
|
||||
funcsave gnew
|
||||
funcsave gimp
|
||||
funcsave gfix
|
||||
funcsave grlz
|
||||
funcsave gdoc
|
||||
funcsave gtst
|
||||
```
|
||||
|
||||
If you prefer, you can paste these aliases directly in your **~/.gitconfig** file:
|
||||
|
||||
```
|
||||
# Git Commit, Add all and Push — in one step.
|
||||
cap = "!f() { git add .; git commit -m \"$@\"; git push; }; f"
|
||||
|
||||
# NEW.
|
||||
new = "!f() { git cap \"📦 NEW: $@\"; }; f"
|
||||
# IMPROVE.
|
||||
imp = "!f() { git cap \"👌 IMPROVE: $@\"; }; f"
|
||||
# FIX.
|
||||
fix = "!f() { git cap \"🐛 FIX: $@\"; }; f"
|
||||
# RELEASE.
|
||||
rlz = "!f() { git cap \"🚀 RELEASE: $@\"; }; f"
|
||||
# DOC.
|
||||
doc = "!f() { git cap \"📖 DOC: $@\"; }; f"
|
||||
# TEST.
|
||||
tst = "!f() { git cap \"✅ TEST: $@\"; }; f"
|
||||
```
|
||||
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
via: https://opensource.com/article/19/2/emoji-log-git-commit-messages
|
||||
|
||||
作者：[Ahmad Awais][a]
|
||||
选题：[lujun9972][b]
|
||||
译者：[译者ID](https://github.com/译者ID)
|
||||
校对：[校对者ID](https://github.com/校对者ID)
|
||||
|
||||
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译，[Linux中国](https://linux.cn/) 荣誉推出
|
||||
|
||||
[a]: https://opensource.com/users/mrahmadawais
|
||||
[b]: https://github.com/lujun9972
|
||||
[1]: https://github.com/ahmadawais
|
||||
[2]: https://github.com/ahmadawais/Emoji-Log/
|
||||
[3]: https://github.com/ahmadawais/VSCode-Tips-Tricks
|
||||
[4]: https://github.com/ahmadawais/shades-of-purple-vscode/commits/master
|
||||
[5]: https://github.com/ahmadawais/shades-of-purple-vscode/blob/master/CHANGELOG.md
|
||||
[6]: https://gitmoji.carloscuesta.me/
|
||||
[7]: https://VSCode.pro
|
||||
[8]: https://en.wikipedia.org/wiki/Friendly_interactive_shell
|
||||
@ -0,0 +1,169 @@
|
||||
[#]: collector: (lujun9972)
|
||||
[#]: translator: (MjSeven)
|
||||
[#]: reviewer: ( )
|
||||
[#]: publisher: ( )
|
||||
[#]: url: ( )
|
||||
[#]: subject: (Emoji-Log: A new way to write Git commit messages)
|
||||
[#]: via: (https://opensource.com/article/19/2/emoji-log-git-commit-messages)
|
||||
[#]: author: (Ahmad Awais https://opensource.com/users/mrahmadawais)
|
||||
|
||||
Emoji-Log：编写 Git 提交信息的新方法
|
||||
======
|
||||
使用 Emoji-Log 为你的提交添加上下文。
|
||||
|
||||
|
||||
我是一名全职开源开发人员，我喜欢称自己为“开源者”。我从事开源软件工作已经超过十年，并[构建了数百个][1]开源软件应用程序。
|
||||
|
||||
同时我也是不要重复自己 Don't Repeat Yourself（DRY）哲学的忠实粉丝，并且相信编写更好的 Git 提交消息是 DRY 的一个重要组成部分。它们具有足够的上下文关联可以作为你开源软件的变更日志。我编写的众多工作流之一是 [Emoji-Log][2]，它是一个简单易用的开源 Git 提交日志标准。它通过使用表情符号来创建更好的 Git 提交消息，从而改善了开发人员的体验（DX）。
|
||||
|
||||
我使用 Emoji-Log 构建了 [VSCode Tips & Tricks 仓库][3] 和我的 🦄 [紫色 VSCode 主题仓库][4]，以及一个看起来很漂亮的[自动变更日志][5]。
|
||||
|
||||
### Emoji-Log 的哲学
|
||||
|
||||
我喜欢表情符号，我很喜欢它们。编程，代码，极客/书呆子，开源...所有这一切本质上都很枯燥，有时甚至很无聊。表情符号帮助我添加颜色和情感。想要将感受添加到 2D、平面和基于文本的代码世界并没有错。
|
||||
|
||||
相比于[数百个表情符号][6]，我学会了更好的办法是保持小类别和普遍性。以下是指导使用 Emoji-Log 编写提交信息的原则：
|
||||
|
||||
1. **必要的**
|
||||
* Git 提交信息是必要的。
|
||||
* 像下订单一样编写提交信息。
|
||||
* 例如，使用 ✅ **Add** 而不是 ❌ **Added**
|
||||
* 例如，使用 ✅ **Create** 而不是 ❌ **Creating**
|
||||
2. **规则**
|
||||
* 少数类别易于记忆。
|
||||
* 不多不也少
|
||||
* 例如 **📦 NEW** , **👌 IMPROVE** , **🐛 FIX** , **📖 DOC** , **🚀 RELEASE**, **✅ TEST**
|
||||
3. **行为**
|
||||
* 让 Git 基于你所采取的操作提交
|
||||
* 使用像 [VSCode][7] 这样的编辑器来提交带有提交信息的正确文件。
|
||||
|
||||
### 编写提交信息
|
||||
|
||||
仅使用以下 Git 提交信息。简单而小巧的占地面积是 Emoji-Log 的核心。
|
||||
|
||||
1. **📦 NEW: 必要的信息**
|
||||
* 当你添加一些全新的东西时使用。
|
||||
* 例如 **📦 NEW: 添加 Git 忽略的文件**
|
||||
2. **👌 IMPROVE: 必要的信息**
|
||||
* 用于改进/增强代码段，如重构等。
|
||||
* 例如 **👌 IMPROVE: 远程 IP API 函数**
|
||||
3. **🐛 FIX: 必要的信息**
|
||||
* 修复 bug 时使用，不用解释了吧？
|
||||
* 例如 **🐛 FIX: Case converter**
|
||||
4. **📖 DOC: 必要的信息**
|
||||
* 添加文档时使用，比如 README.md 甚至是内联文档。
|
||||
* 例如 **📖 DOC: API 接口教程**
|
||||
5. **🚀 RELEASE: 必要的信息**
|
||||
* 发布新版本时使用。例如， **🚀 RELEASE: Version 2.0.0**
|
||||
6. **✅ TEST: 必要的信息**
|
||||
* 发布新版本时使用。
|
||||
* 例如 **✅ TEST: 模拟用户登录/注销**
|
||||
|
||||
就这些了，不多不少。
|
||||
|
||||
### Emoji-Log 函数
|
||||
|
||||
为了快速构建原型，我写了以下函数，你可以将它们添加到 **.bashrc** 或者 **.zshrc** 文件中以快速使用 Emoji-Log。
|
||||
|
||||
```
|
||||
#.# Better Git Logs.
|
||||
|
||||
### Using EMOJI-LOG (https://github.com/ahmadawais/Emoji-Log).
|
||||
|
||||
# Git Commit, Add all and Push — in one step.
|
||||
|
||||
function gcap() {
|
||||
git add . && git commit -m "$*" && git push
|
||||
}
|
||||
|
||||
# NEW.
|
||||
function gnew() {
|
||||
gcap "📦 NEW: $@"
|
||||
}
|
||||
|
||||
# IMPROVE.
|
||||
function gimp() {
|
||||
gcap "👌 IMPROVE: $@"
|
||||
}
|
||||
|
||||
# FIX.
|
||||
function gfix() {
|
||||
gcap "🐛 FIX: $@"
|
||||
}
|
||||
|
||||
# RELEASE.
|
||||
function grlz() {
|
||||
gcap "🚀 RELEASE: $@"
|
||||
}
|
||||
|
||||
# DOC.
|
||||
function gdoc() {
|
||||
gcap "📖 DOC: $@"
|
||||
}
|
||||
|
||||
# TEST.
|
||||
function gtst() {
|
||||
gcap "✅ TEST: $@"
|
||||
}
|
||||
```
|
||||
|
||||
要为 [fish shell][8] 安装这些函数，运行以下命令：
|
||||
|
||||
```
|
||||
function gcap; git add .; and git commit -m "$argv"; and git push; end;
|
||||
function gnew; gcap "📦 NEW: $argv"; end
|
||||
function gimp; gcap "👌 IMPROVE: $argv"; end;
|
||||
function gfix; gcap "🐛 FIX: $argv"; end;
|
||||
function grlz; gcap "🚀 RELEASE: $argv"; end;
|
||||
function gdoc; gcap "📖 DOC: $argv"; end;
|
||||
function gtst; gcap "✅ TEST: $argv"; end;
|
||||
funcsave gcap
|
||||
funcsave gnew
|
||||
funcsave gimp
|
||||
funcsave gfix
|
||||
funcsave grlz
|
||||
funcsave gdoc
|
||||
funcsave gtst
|
||||
```
|
||||
|
||||
如果你愿意，可以将这些别名直接粘贴到 **~/.gitconfig** 文件：
|
||||
```
|
||||
# Git Commit, Add all and Push — in one step.
|
||||
cap = "!f() { git add .; git commit -m \"$@\"; git push; }; f"
|
||||
|
||||
# NEW.
|
||||
new = "!f() { git cap \"📦 NEW: $@\"; }; f"
|
||||
# IMPROVE.
|
||||
imp = "!f() { git cap \"👌 IMPROVE: $@\"; }; f"
|
||||
# FIX.
|
||||
fix = "!f() { git cap \"🐛 FIX: $@\"; }; f"
|
||||
# RELEASE.
|
||||
rlz = "!f() { git cap \"🚀 RELEASE: $@\"; }; f"
|
||||
# DOC.
|
||||
doc = "!f() { git cap \"📖 DOC: $@\"; }; f"
|
||||
# TEST.
|
||||
tst = "!f() { git cap \"✅ TEST: $@\"; }; f"
|
||||
```
|
||||
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
via: https://opensource.com/article/19/2/emoji-log-git-commit-messages
|
||||
|
||||
作者：[Ahmad Awais][a]
|
||||
选题：[lujun9972][b]
|
||||
译者：[MjSeven](https://github.com/MjSeven)
|
||||
校对：[校对者ID](https://github.com/校对者ID)
|
||||
|
||||
本文由 [LCTT](https://github.com/LCTT/TranslateProject) 原创编译，[Linux中国](https://linux.cn/) 荣誉推出
|
||||
|
||||
[a]: https://opensource.com/users/mrahmadawais
|
||||
[b]: https://github.com/lujun9972
|
||||
[1]: https://github.com/ahmadawais
|
||||
[2]: https://github.com/ahmadawais/Emoji-Log/
|
||||
[3]: https://github.com/ahmadawais/VSCode-Tips-Tricks
|
||||
[4]: https://github.com/ahmadawais/shades-of-purple-vscode/commits/master
|
||||
[5]: https://github.com/ahmadawais/shades-of-purple-vscode/blob/master/CHANGELOG.md
|
||||
[6]: https://gitmoji.carloscuesta.me/
|
||||
[7]: https://VSCode.pro
|
||||
[8]: https://en.wikipedia.org/wiki/Friendly_interactive_shell
|
||||
Loading…
Reference in New Issue
Block a user