search

carloscuesta / gitmoji

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

Highlighting related projects #371

Closed kefranabg closed 4 years ago

kefranabg commented 5 years ago

Hello @carloscuesta :sunglasses:!

First thanks for your awesome work! I love it and I use it for all my projects ❤️

I use a great project that helps me to generate my changelogs using your commit convention: gitmoji-changelog.

I think it would be nice to let your users know that they could use this tool, maybe in a Related projects section? I can do a PR if you want.

carloscuesta commented 5 years ago

Hey @kefranabg

I totally forgot about this (#269), in fact there's already a PR from the gitmoji-changelog author to add a section pointing to the project.

I don't have any problems on adding a related projects section, but based on what ? I don't want to bloat the main readme file with a lot and bunch of links.

The question for me is, how we should decide what kind of projects go on that list? If you accept one, why you wouldn't be accepting anything ?

kefranabg commented 5 years ago

I think you should pick project you like, and that might help a high percentage of gitmoji users (like gitmoji-cli). And I think this is the case of gitmoji-changelog 😄

ghost commented 4 years ago

I don't want to bloat the main readme file with a lot and bunch of links.

I'm not seeing your logic here. Didn't you just bloat a CLI full of emojis?

frinyvonnick commented 4 years ago

Hi @carloscuesta, @kefranabg :wave:

Last version of gitmoji-changelog comes with a preset system that enables every kind of repositories to use it (previously only JavaScript repositories). In my opinion having a changelog is really useful to inform users about changes between versions on your project. It seems to be a common use case.

Maybe a project can be added in a related section of your README if it concerns most of the gitmoji's users?

ivanhercaz commented 4 years ago

Nice idea @kefranabg!

@carloscuesta, an option to not bloat the README may be to create another markdown file in which it would be possible to add the related projects (e.g., RELATED_PROJECTS.md). Then in the README you might have a small section titled "Related projects" in which you explain shortly that there are projects derived from Gitmoji. If anyone wants to add a project to this list, the proposer could open a PR and in this PR discuss if the project should be added or not, unless it will be clear the answer.

P.S. And thanks! <3 I didn't know about gitmoji-changelog and it seems a very useful tool.

carloscuesta commented 4 years ago

Closed at #269

KaKi87 commented 4 years ago

I supose we can also add the following :