Intro

perfekt is a release, changelog and versioning manager. It's easy to use and doesn't require any configuration to get it up and running.

Convention

For perfekt to run with its full power, your project must follow the conventional commits specification, this allows it to know the type of changes introduced in a given commit.

If your project doesn't do it yet, you can start any time as there is no need for rewriting any git history, simply create an initial release which will contain all of the unconventional commits and after that start naming your commits accordingly.

If for some reason you can't follow the convention for your commits' names, you can still use perfekt but you will lose some of the features, like grouping the commits by type or ability to automatically determine the next release version based on unreleased changes using new keyword in the perfekt release new command, about which you can read more here.

Getting started

For a quick introduction and set up instructions head to the getting started section.

You can also view the entire documentation online at lekterable.github.io/perfekt

Badge

Would you like to let the whole world know that your project is under the perfekt management?

[![management: perfekt👌](https://img.shields.io/badge/management-perfekt👌-red.svg?style=flat-square)](https://github.com/lekterable/perfekt)

[![management: perfekt👌](https://img.shields.io/badge/management-perfekt👌-red.svg?style=for-the-badge)](https://github.com/lekterable/perfekt)

License

MIT