🧹 New Gitmoji for technical debt

[GhostFancy]

Emoji symbol

🧹

Emoji code

:broom:

Emoji description

For cleaning/addressing up of techdebt

Describe the use case of your emoji

Features/tasks might require developers to take shortcuts in order to achieve delivery of said feature/task. This typically means writing code that works, but could be improved and therefore introduces technical debt that will be addressed at a later stage when the developer/team has more time on their hands. This emoji is great as it entails that a developer has come back to clean up and improve their code.

For more information regarding techdebt, I like to use the following write up that highlights some of the main causes and usages of techdebt: Technical Debt

Is this use case covered by an existing emoji?

No ❌

Does this emoji fall into the "how" or the "what" category?

• [ ] This proposal do not describe "how" a commit was made, but does in fact describe "what" is the contents of the commit about.

Examples

🧹Improve validation rules for name input field 🧹Add additional error scenarios for api call 🧹Adopt framework "ABC" that addresses feature Z's requirements better

Validations

• [X] Follow our Code of Conduct
• [X] Read the Contributing Guide.
• [X] Check that there isn't already an issue requesting the emoji.

[vhoyer]

now consider those instead:

:children_crossing: Improve validation rules for name input field :goal_net: Add additional error scenarios for api call :heavy_plus_sign: Adopt framework "ABC" that addresses feature Z's requirements better

why would we want to flag a commit as tech. debt?

[GhostFancy]

The idea is the developer/s and customer have negotiated that some task was rushed and therefore needs to be re-addressed again in the future. By either commiting or (in perhaps the case where I see this best fitting) setting the title of a pull request, it clearly marks to other developers (who might not be aware of the fact that it was tech debt) that you are making changes to work that was considered rushed.

It's to merely have more visibility as to what the commit or pull request entails.

I do agree with your examples, whereby we could possibly use other emojis, however, that is for commit messages. I do still strongly believe that to mark a pull request with the 🧹 indicates that the work you did was to address tech debt.

[vhoyer]

I can advocate that this technical debt emoji is a how emoji, since it describes that the "what" was done in the commit was done with the quality of "technical debt".

Rather than calling it "how" we could call it "context", but the same thing applies to the other "how" emojis

[GhostFancy]

True. I'm happy to update the issue to be a how instead of a what.

[MincDev]

I agree with @GhostFancy that this could be a useful gitmoji in a pull request. There's no general gitmoji for addressing some techdebt.

[vhoyer]

We are trying to always describe/categorize "what" has been done in a particular commit, not the "how" it was done (the exceptions being 💩 and 🍻).

Notice here that, by the descriptions on the "how" category, you can't know what has been achieved in the commit.

Examples of "what" commits | Examples of "how" commits -- | -- ✅ Add, update, or pass tests | 💩 Write bad code that needs to be improved 🔒 Fix security issues | 🍻 Write code drunkenly ⚡ Improve performance | 🤖 Write an automated commit by a script

as the technical debt emoji kinda falls in the same bucket as the other "how" emojis, we do not intend on adding it

• © Githubissues.
• Githubissues is a development platform for aggregating issues.