Gitmoji: Add new 💭emoji for adding / modifying informative comments in code

Created on 30 Dec 2019  ·  6Comments  ·  Source: carloscuesta/gitmoji

Hello @carloscuesta :sunglasses:!

  • Emoji: 💭
  • Code: :thought_balloon:
  • Description: "Adding or updating comments in code"

Although in ideal programming world code should be self descriptive, reality shows that sometimes it is really helpful to introduce some context info or short explanation of decisions made in code.

Taking above into consideration I propose to introduce emoji 💭identifying commits where comments were added to code or modified.

Currently there is not such an emoji, the closest ones are:

  • :pencil: or :bulb: - but documentation is something different then comment
  • :recycle: - but it is not always about refactoring
  • :beers: - if we discuss all the how's and why's in pub or sth ;)
community-loves-it emoji

Most helpful comment

@MarcoGorelli ok then, I can see it can cause confusion. So what about changing description of 💡to clearly distinct it from 📝 ?

For example change it to description I proposed here: _"Adding or updating comments in code"_

It will be backward compatible (😄) and remove confusion which one use for documenting and which for code comments.

All 6 comments

To be honest this is what I thought :bulb: was for. I've been using :pencil: for documentation (including docstrings) and :bulb: for source code comments

Ok that a great implementation

@MarcoGorelli ok then, I can see it can cause confusion. So what about changing description of 💡to clearly distinct it from 📝 ?

For example change it to description I proposed here: _"Adding or updating comments in code"_

It will be backward compatible (😄) and remove confusion which one use for documenting and which for code comments.

Love the idea of updating the :bulb:'s comment. What do you think about this idea @carloscuesta, @vhoyer?

I love this idea also, I used to be confused between :bulb: and :memo: but have been using bulb for comments for months :D

@Hunter71 Would you have the time to create a PR? 👍

Was this page helpful?
0 / 5 - 0 ratings