You might be surprised, but people love to read blog posts or an update page on your website.įor a developer, for example, if the project is big, it can be interesting to know how the software they're working on is evolving. In a world where everything is evolving quickly, a user needs to know if the website/software they are using is changing. It should be easy to understand both by the users using your project and the developers working on it. I think, even now, you are asking yourself why it is essential and why you should take the time to create it.Ī changelog is a kind of summary of all your changes. The project is often a website or software project, and the changelog usually includes records of changes such as bug fixes, new features, etc.” – Wikipedia Why is it essential? “A changelog is a log or record of all notable changes made to a project. I have good news for you – this is what you’re going to learn in this article! the developer choice (alias the lazy option): auto-generate your changelog from your commit messages.the usual way: create a text file and start to enumerate all your changes with a specific date.Globally, there are two ways to write a changelog: It’s often organized by the version with the date followed by a list of added, improved, and removed features. In this article, you will learn what a changelog is along with two ways to generate it – a simple one and a sophisticated one.Ī changelog is a file that shares a chronologically ordered list of the changes you've made on your project. I gave you an overview of the benefits of writing a good commit, and I mentioned the possibility of generating a changelog. In the last part of this series, I shared with you how to write a good commit message.

You want to share the changes you made with your users, but you don’t know how. Say you are a developer, and you use Git for one of your projects.

Better discord download github