✨ Use consistent emojis to indicate the PR/Issue type

[mbercx]

I recently found out that my MacBook pro's touch bar allows me to quickly and easily look for emojis. This discovery, in combination with some quarantine-induced bouts of mental instability, have made me very giddy about using them pretty much everywhere (as anyone who's been reading my meeting notes recently can testify).

Then I saw the executablebooks/sphinx-copybutton commit list, and I got jealous of how pretty it looks.

So, maybe we can also start using these consistently for our PR's and commits? 🙏

On a more serious note, I think using these consistently can help with sorting the changes for the release changelogs, and it's shorter to add e.g. 📚 than DOCS:, 🔧 than FIX: or ✨ than ENHANCEMENT:.

[chrisjsewell]

I've been saying this for ages lol; who do you think implemented those emojis across the whole of the executablebooks organisation, this guy 🙋‍♂️

• Implement Git Commits Convention (w/ Emoji)  executablebooks/meta#74
• https://github.com/executablebooks/.github/blob/master/CONTRIBUTING.md#commit-messages

[mbercx]

I've been saying this for ages lol; who do you think implemented those emojis across the whole of the executablebooks organisation, this guy 🙋‍♂️

Hehe, I figured I would have your support. 😅 I was just curious what the others thought and if we could get the ⚽ rolling on this.

[chrisjsewell]

indeed and its already used for quantum mobile and all that organisation 😉 : https://github.com/marvel-nccr/quantum-mobile

[mbercx]

[chrisjsewell]

[greschd]

Well, for a bit of a contrarian view: I'm not really excited about the emoji business. While great for casual conversation, I wouldn't put it in commit messages.

Off the top of my head:

• can you grep for that?
• it's inconvenient for people that don't have an emoji picker easily available
• I'm not sure if the 🔧 <-> FIX etc. translation is "universally accepted standard" - if it isn't, it seems a burden having to remember it for each project. At least at first glance, this is much less understandable to me
• Not sure about the accessibility of using emojis

That's just my gut reaction - but if everyone else loves it I wouldn't mind all that much ¯\_(ツ)_/¯

[chrisjsewell]

some quick responses:

1. emojis are part of the utf8 standard convention, they are available on every modern platform and terminal and everyone knows how to use them.
2. The commit titles should be easy to scan not read, thats what the commit messages are for, its perfectly fine for them to be slightly ambiguous. No one sits there and reads all the commit titles unless they have to, the point is that you can very quickly look at a list of commits and identify their type; documentation, bug fixes, new features; then you can look at the full commit messages for greater context.
3. You can't lint commit messages, because they are written after the CI, generally within the GitHub web interface

[sphuber]

emojis are part of the utf8 standard convention, they are available on every modern platform and terminal and everyone knows how to use them.

I might be a ludite, but I have no clue how to insert an emoticon from my terminal.

The commit titles should be easy to scan not read, thats what the commit messages are for, its perfectly fine for them to be slightly ambiguous. No one sits there and reads all the commit titles unless they have to, the point is that you can very quickly look at a list of commits and identify their type; documentation, bug fixes, new features; then you can look at the full commit messages for greater context.

I agree that the titles should be quick to scan, but the "type" is not the only important information. I would argue that the scope or subject of the commit is even more important, i.e. what part of the code is affected, e.g., Engine, CalcJob, WorkChain or CLI, etc

You can't lint commit messages, because they are written after the CI, generally within the GitHub web interface

Commit messages are also written when you commit and so they can be linted using a commit post-hook.

[chrisjsewell]

I might be a ludite, but I have no clue how to insert an emoticon from my terminal.

just copy/paste them into, if nothing else. But who knows, I'm not a ludite, I rarely use git from the terminal, when theres much better interfaces, like vs code or Github desktop 😜

what part of the code is affected, e.g., Engine, CalcJob, WorkChain or CLI, etc

this would rarely be singular though surely. It may be better to add a yaml-type tag to the top of the commit message, e.g. tags: [engine, cli]

Commit messages are also written when you commit and so they can be linted using a commit post-hook.

if you can work out how to enforce this on the GitHub web interface, then I'm happy to stand corrected

[greschd]

just copy/paste them into, if nothing else

🥴

On Windows there's Win + ., on Linux I haven't found a good consistent way of doing it. But copy/paste is IMO unacceptable, that's just a giant waste of time. Searching for the emojis in a picker is already tedious enough..

theres much better interfaces, like vs code or Github desktop

Let's not pretend we can solve the age-old CLI vs GUI debate here..

[chrisjsewell]

well I guess we will have to agree to disagree