carloscuesta / gitmoji

An emoji guide for your commit messages. 😜
https://gitmoji.dev
MIT License
15.62k stars 799 forks source link

🦺 for validation changes #1136

Closed cnfw closed 1 year ago

cnfw commented 2 years ago

Emoji symbol

🦺

Emoji code

:safety_vest:

Emoji description

Validation logic/schema changes

Describe the use case of your emoji

Often features are developed rapidly with little thought given to validation checks on user-submitted data (at least initially), and so work can be done at a later stage to add or improve the validation on API requests, form submissions, etc.

In these cases, it's hard to determine which is the best gitmoji to use.

It could be business logic, it could be a new "feature" (if you consider validation a feature), it could be a bug fix (updating incorrect validation rules), but in all of these cases, tracking down changes to validation is harder to spot in a commit timeline without an emoji of its own.

The choice of safety vest comes as validation gives visibility to potential errors if the code was to proceed with given data.

Is this use case covered by an existing emoji?

No ❌

Does this emoji fall into the "how" category?

No

Examples

Validations

mike-mccormick commented 2 years ago

I'd definitely use this!

vhoyer commented 1 year ago

When faced with this example I generally use the :children_crossing: (Improve user experience / usability), as for systems the likes of an Http API I view that the "user" are the programmers using it, or even the client requesting from this server, so improvements on error validation are definitly a "user experience improvement" in my world view.

What do you think about using this on this cases?

carloscuesta commented 1 year ago

Hey!

I like the idea behind this suggestion 😍

When faced with this example I generally use the :children_crossing: (Improve user experience / usability), as for systems the likes of an Http API I view that the "user" are the programmers using it, or even the client requesting from this server, so improvements on error validation are definitly a "user experience improvement" in my world view.

I understand this point of view but when going through the commit log that could fall into UX / Usability

It could be business logic, it could be a new "feature" (if you consider validation a feature), it could be a bug fix (updating incorrect validation rules), but in all of these cases, tracking down changes to validation is harder to spot in a commit timeline without an emoji of its own.

Personally I would use "business logic" but it's not 100% accurate on this case, so in my opinion I would be happy to introduce this one! 😊

Feel free to send a PR! 🙏🏼