DEV Community

loading...

Discussion on: 🔨 [git]: Write better commits with Gitmoji

Collapse
johnnywalkerdesign profile image
Johnny Walker • Edited

I'm not sure you understand how Conventional Commits are supposed to work. This is not an example of one:

<feat> [home, components]: Add login button

This is how that should be written in a real commit example:

feat(home, components): add login button

The angled brackets are an indication of "required", not something you're supposed to type.

Collapse
foresthoffman profile image
Forest Hoffman

Hi Johnny, this comment comes off as aggressive and doesn't add anything to the discussion. Please, review the Dev.to Code of Conduct.

This post is a custom solution that appears to be loosely based on the Conventional Commits format, since it uses emojis instead of plain text. However, this correction isn't accurate. The examples the author used include square brackets like the documentation shows.

Collapse
johnnywalkerdesign profile image
Johnny Walker • Edited

It wasn't my intention to come off as aggressive. I took the time to point out a mistake in the article. I don't see how you can say it "doesn't add anything to the discussion". That comes off as totally disingenuous.

Please scroll down to the Examples section in the link you provided. I took the time to research before I posted, including looking at the commit history of several repositories that listed as examples of projects that follow this pattern.

Thread Thread
foresthoffman profile image
Forest Hoffman

Ahh, interesting. So, the author isn't following that pattern at all. Generally speaking, e.g. in Bash, square brackets indicates an optional parameter. Both the conventional commits format and the gist they linked to doesn't stick to that standard.

Thread Thread
johnnywalkerdesign profile image
Johnny Walker

Yeah, it's a bit confusing isn't it? They're linking to a pattern as an example to follow, but not following it in their examples. I don't get it.

Thread Thread
foresthoffman profile image
Forest Hoffman

That is odd.

Kudos for pointing out a potential typo! Let's aim for a more passive voice when pointing them out in the future.

Cheers!

Thread Thread
javidjms profile image
Javid Mougamadou Author

Hi,

I am sorry for the confusion.

Thanks to Johnny and Forest for the correction and the reactivity.

I will update the post with the correction.

Javid.

Thread Thread
johnnywalkerdesign profile image
Johnny Walker • Edited

@foresthoffman Let's aim for less trigger-happy reactions and condescension, and maybe assuming good intentions, while we're at it.

Thread Thread
foresthoffman profile image
Forest Hoffman

No worries, Javid! Keep up the great work :)

Thread Thread
foresthoffman profile image
Forest Hoffman

I appreciate that your intention wasn't to be aggressive. My interpretation of the original comment, "I'm not sure you understand how Conventional Commits are supposed to work. This is NOT an example of one", was not one of tactful criticism. Therefore, I expressed that the comment could be interpreted as aggressive. The original comment didn't include the link that you later provided, which points out that there was a disconnect between what was in the article and the documentation being linked to.

New accounts are joining dev everyday, and sometimes a comment like this pops up. I of course didnt mean any personal offense. I'm just one of many members that want to ensure that there's an even playing field of constructive criticism and positivity.

Have a good one!

Forem Open with the Forem app