Comments (9)
Useful git commit message is short and to stay concise a good commit message avoid useless characters (think twitter in its earlier stage or in SMS protocol).
If you think an emoji is mandatory, then it should be placed in the Subject
as defined in the current guidelines: feat: :hammer_and_wrench: Informative subject
or a more concise version with the unicode character: feat: 🛠 Informative subject with more characters
.
But git commit history ain't a bullet journal, it is useful for humans and machines to understand what is going on on the project.
There is plainty of git client, like github, official git CLI or gitk, that will display messages in one or another format (only the first 50 characters, :text_unicode:
replaced by the corresponding emoji, etc.). To ensure every body could read in a very effective way the git history, we have to keep only very useful characters in the Subject.
You can add more details in the Body of the commit message (after the subject, insert a blank line and be as long as you need to explain, illustrate, etc. the change you are commiting).
For instance, I created a blank git project with different kind of message:
https://github.com/enguerran/emojiincommit/commits/master
Take a look at the git commit messages in github:
With git log
in my own terminal:
A lot of people recommend to stay to 50 characters in the subject (see Linux kernel repo):
- https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
- https://stackoverflow.com/questions/2290016/git-commit-messages-50-72-formatting
- https://udacity.github.io/git-styleguide/
- https://git.wiki.kernel.org/index.php/CommitMessageConventions
- http://365git.tumblr.com/post/3308646748/writing-git-commit-messages
- https://commit.style/
- https://chris.beams.io/posts/git-commit/
from cozy-guidelines.
I am reading the commits of cozy-bar that have emojis in front. I find them very hard to parse. Since when scanning you are watching for fix/feat/chore etc... the emojis in front just add noise. I would be in favor of banning this usage :)
from cozy-guidelines.
👍 to the end of message, because it's not important and not required
from cozy-guidelines.
Correct me if I'm wrong but an emoji as an UTF-8 character is 1 character is the count of 50, isn't it?
I personally think that an Emoji is a good way to display a more or less long information with only one character, so I don't see it as useless.
from cozy-guidelines.
Yes, it is one character if you use the Unicode version, but the length is not defined if you use the :text_emoji:
version. That is illustrated in the picture: prefer the Unicode version.
The important is to be clear for other people. If every body understand what fix: Transplant a new ♥️
means, I see nothing to stop using an emoji instead of a word (fix: Transplant a new heart
).
from cozy-guidelines.
I would be in favor of banning this usage :)
of emojis at the beginning of the commit message or emojis at all ?
The thing is every argument I read is only about personal perception. I personally like emojis, I think that an emoji is actually far more easy to parse with your eyes than reading a word. Well, this works only if we all use the same "rules" of use. But I do understand that some of us could be insensitive to emojis.
As far I see it, nobody's right, nobody's wrong. But is there a way to find a middle ground here, so everybody can be happy? Maybe by writing emojis at the end of the commit for example.
from cozy-guidelines.
Yep, the middle ground would be to put emojis at the end of the commit message. This way automatic releases don't need a specific parser, those who like the emoji's visual information have it, and those who don't like emojis don't have it under their eyes directly.
from cozy-guidelines.
Seems OK to me, GoOz would you be OK to do the PR ?
from cozy-guidelines.
Sure
from cozy-guidelines.
Related Issues (20)
- Spinner HOT 4
- Fonts HOT 1
- Use contextualized localisation files HOT 1
- How to write polyglot keys? HOT 8
- Use "not" instead of "!" in Coffeescript
- Update l10n guidelines HOT 1
- Add contributing guidelines HOT 2
- Move this repository to Github pages HOT 5
- Add a link to guidelines into the main repository
- How we should write mocha tests HOT 8
- Add doc on ducks HOT 1
- Standardization of git commit messages HOT 2
- Add an optional scope to git messages HOT 2
- Process discussion: bug report HOT 12
- add a paragraph about breaking change
- REST responses HOT 5
- Improvements
- Release cycle / process HOT 2
- fast return HOT 12
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cozy-guidelines.