Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
134dfb9

Git stats

Files

Permalink
Failed to load latest commit information.

README.md

gitmoji-changelog logo

Gitmoji Twitter: YvonnickFrin

Generate changelog for repositories using gitmoji commits convention.

gitmoji-changelog usage example

πŸš€ Usage

Make sure you have npx installed (npx is shipped by default since npm 5.2.0)

Run the following command at the root of your project and answer questions. gitmoji-changelog uses a preset system to handle different type of project. The preset used by default is the Node.js one that look for project's information in the package.json file.

with npx:

npx gitmoji-changelog

with npm:

npm install -g gitmoji-changelog

cd my-project
gitmoji-changelog

It exists a generic preset that works for every kind of project. It looks for information in a .gitmoji-changelogrc file at the root of your project. This file must contain three mandatory properties: name, description and version.

.gitmoji-changelogrc:

{
  "project": {
    "name": "gitmoji-changelog",
    "description": "A changelog generator for gitmoji 😜",
    "version": "2.0.1"
  }
}

You can change the preset used by gitmoji-changelog with the preset option.

npx gitmoji-changelog --preset generic

πŸ“– Documentation

πŸ‘‰ The full documentation is available here.

✍ Author

πŸ‘€ Yvonnick FRIN (https://yvonnickfrin.dev)

🀝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at our contributing guide.

πŸ™ Show your support

Give a ⭐️ if this project helped you!

You also can add a badge in the README.md of your repository to promote gitmoji-changelog. All you need is to copy/past the code below:

[![gitmoji-changelog](https://img.shields.io/badge/Changelog-gitmoji-brightgreen.svg)](https://github.com/frinyvonnick/gitmoji-changelog)

It will add this badge: gitmoji-changelog

✨ Contributors

Thanks goes to these wonderful people (emoji key):


Yvonnick FRIN

πŸ’»

Benjamin Petetot

πŸ’»

Fabien JUIF

πŸ’»

Baptiste Gauduchon

πŸ’»

Franck Abgrall

πŸ’»

quentinncl

πŸ’»

Logan HAUSPIE

πŸ’»

Guillaume MembrΓ©

πŸ’»

Yann Bertrand

πŸ’»

s n

πŸ’»

Mathieu TUDISCO

πŸ’»

Charles-Henri GUERIN

πŸ’»

Florent Berthelot

πŸ’»

Emmanuel DEMEY

πŸ’»

Christopher Kade

πŸ“

Rodion Martynov

πŸ“–

Daniel Tamkin

πŸ“–

Erno Salo

πŸ“–

Mark Lyck

πŸ’»

This project follows the all-contributors specification. Contributions of any kind welcome!

πŸ“ License

Copyright Β© 2020 Yvonnick FRIN (https://github.com/frinyvonnick).
This project is MIT licensed.


This README was generated with ❀️ by readme-md-generator