Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Secondary Gitmoji, or what to do with 💥 #1425

Open
TristanCottam opened this issue Apr 15, 2023 · 5 comments
Open

Secondary Gitmoji, or what to do with 💥 #1425

TristanCottam opened this issue Apr 15, 2023 · 5 comments
Labels
discussion Discussions about the proposal of an emoji.

Comments

@TristanCottam
Copy link

TristanCottam commented Apr 15, 2023

The problem

Certain Gitmoji don't represent intentions themselves, but rather give additional context to the changes made (most notably 🚧, 💩, 🍻, and 💥). Considering only the single most relevant Gitmoji should be included in a commit message, and intention is always more relevant than context, these would theoretically never be used.

Possible alternatives

  • 🚧 could be by expressed through other means, e.g. branches.
  • 💩 could be expressed by a TODO comment above the relevant code block.
  • 🍻 is irrelevant, and in my opinion should be removed.
  • 💥 is essential, and must be expressed separately from the intention of the commit.

Allowing the use of secondary Gitmoji in commits, through one way or another, would solve this problem, but such a feature is subject to discussion. However, expressing breaking changes separately from the intention is essential.

My opinion

Since breaking changes often deserve additional context, they could be expressed as a footer in the commit body, in the same way as Conventional Commits.

On a side note: the "Example of usage" (syntax specification) in README.md should include the (optional) commit body, as it is currently unclear the standard allows it.

@TristanCottam TristanCottam added the discussion Discussions about the proposal of an emoji. label Apr 15, 2023
@Thanyanit-J
Copy link

I used 🚧 when I'm about to take my day off, but my boss want to see my unfinished works. He wanted me to commit and push anyway so this emoji fit perfectly. Just make sure to remind myself to undo the commit.

But yeah, creating a new temporary branch works too, and probably better since if I accidentally include 🚧 (which I did two times), the git blame gonna looks so scary.

The commit "🚧 WIP: DO NOT MERGE" actually got merged lol. This would not happen if I created a new temporary branch.


For 🍻 and 💩, it's perfect for coding party, fun activity, or hackathon.

@vhoyer
Copy link
Collaborator

vhoyer commented Jul 14, 2023

you have a good point @tristan-cottam, whenever I have to use the 💥 I usually drop any other "intention emojis", as I see the fact that something is a breaking change to be the most relevant fact of that commit, but I see you, I would be down to standardize treating BREAKING CHANGES as we do in conventional commits, seems a good solution.

Really the other three emojis haven't been removed probably due to emotional attachment to them, the one that I use the most is 🚧 and I use it to fix things in previous commits, like, things that I forgot I wanted to include in a past commit, I add a 🚧 then a message to remind me where I wanted to fixup that diff, and when I open the PR, I do a little git rebase in my branch to remove'em, but I digress.

@connorjs
Copy link
Contributor

Regarding "secondary emoji" comment - I toss a second emoji at the end of my title when I feel a second applies.

That being said, my GitHub work seems to have second emojis in arbitrary positions, rather than last (which I believe I was more consistent with at work).

  • ✅ Unit testing with Vitest: 🎉 vitest-config
  • 🤡 Fake Data (and 🏷 document types)
  • 🚨 ESLint: 🎉 eslint-config

I use 🎉 for new projects in monorepo

@connorjs
Copy link
Contributor

@tristan-cottam - is the (primary) goal of this discussion to (a) discuss removing the mentioned emojis, (b) formalize a secondary emoji, (c) formalizing gitmoji for parsing similar to conventional commits, or something else?

@connorjs
Copy link
Contributor

Regarding 🚧 - I proposed using it in #1300 (comment), so removing 🚧 would get my vote for that 🦴 gitmoji (structure/skeleton).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Discussions about the proposal of an emoji.
Projects
None yet
Development

No branches or pull requests

4 participants