Gitmoji: Standard reference to this repository

[brenorb]

Hello @carloscuesta :sunglasses:!

I believe there should be a standard text referencing to this repo, so people can better undestand and propagate this idea. You should suggest in the README section for people who use gitemoji to write in their Contributing Guideline or README sections something like:

This repository follows the gitmoji commit standard.

[grissius]

Hi @brenorb,
I think that is great idea. I think readme section with text is a bit problematic. Are there any other projects using this convention?

All I can think of either use badges (prettier, conventional commits, lint etc.) or keepachangelog, which embeds the text into "managed" format CHANGELOG.md.

I think a custom badge is a way to go. What do you all think?

[carloscuesta]

I quite like the idea of having:

alt="Gitmoji">

[brenorb]

I'm not well versed in open source contributing, but this is how I used in the CONTRIBUTING.md file in a project of mine.

For me it looks a little more clear when it's written, but as I said before, I'm still figuring out how open source contributing works.

Here there is another example of CONTRIBUTING.md file that recommends emojis.

[carloscuesta]

Definitely a CONTRIBUTING.md template could kinda help

[brenorb]

When I first posted this issue, I didn't know CONTRIBUTING.md even existed hahaha
That's why I first suggested on README. Well, I hope that helps. 😄

[grissius]

@carloscuesta @brenorb Thanks for all the inputs. I think the best solution is adding a badge and mention it in CONTRIBUTING.md.

In this matter I think it would be more suitable to have the badge image in this repo, instead of a general link to shields.io, perhaps providing a regular and flat version of the button. This allows us to change the official badge in the future without needing to update the link in all repos using the badge.

Would you agree?

[grissius]

@carloscuesta I agree with the badge.

1. I think it might be better to include just a single emoji (just a preference, but I think it looks more professional and serious, than throwing in two of them)
2. I find it very useful to include a version number. We have some proposals for breaking changes and I think it is convenient to have a clear information about the specific version. conventionalcommits chose to go this way for example.

Using version number on your orange color makes it kindof hard to read.

So maybe we should select a different background color or put the version in the first section:

[grissius]

@carloscuesta ?

[grissius]

I believe this issue is now of top importance. I would try to resolve it ASAP, add to docs and tag Gitmoji with 1.0.0 so we can address non BC changes.

[carloscuesta]

Do you think is valuable to add versioning to this project ? @grissius

I don't know, feels a little bit weird to me, since we're not a dependency of anything, just a convention

[grissius]

I think it is not only valuable, but necessary. How else would we manage non BC changes like removing emojis or changing semantics as proposed in some issues?

Those changes are IMO inevitable sooner or later. As a user of GItmoji I would prefer to know that emoji was deprecated in version X, than finding out randomly that it's just missing in the master branch.

[grissius]

But if you despise the idea of having the version in the badge, IDC that much. But let's at least tag the repo and make new releases when we change the semantics. How about that?

[carloscuesta]

Yes sounds good I will release a 1.0.0 version

[rickinbsb]

I've made this version of the badge. the icon I'm using in it is from font-awesome and it is under creative commons 4.0

[johannchopin]

I love the idea of using this badge:

alt="Gitmoji">

Maybe we can make it more clear in the README :

---

Badge

You are using gitmojis in your entire project? Inform the contributors by using the gitmoji's badge in your README:

<a href="https://gitmoji.carloscuesta.me">
  <img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square" alt="Gitmoji">
</a>

What do you think about it @carloscuesta?

[carloscuesta]

Yes we can set it on the README file 😊