3 reasons to keep a changelog for your project


changelog

Changelog file, what this means ?

Did you forgot what you implemented two months ago ? If the answer is no, probably you don’t need lecithin. But I don’t think that’s the answer.

A changelog file it’s just a history of changes made for a project. It’s very useful to keep track of everything into a single place and to summarize some features than to look throw all the commits from git repository.

Why to keep a Changelog ?

Personally the most important thing for me it’s to keep track of all the changes that I made for a project, specially for webservices, because I need to know what resource I added, changed, removed or if I need fixed a bug or something it’s deprecated.

The second reason it’s about knowing which are the latest changes deployed. Being involved into a big project with multiple developers, branches and features that must be deployed at some points can be hard, because you need to know what was deployed and probably when. I found it very useful to have a header with Unreleased changes.

The last reason that I think it’s relevant here it’s about versions and dates when the deploys were changed. Sometimes we need to know for a specific version which was the changes and when were deployed.

How to do it ?

When I searched for this question I got the best answer for me here. Keep a Changelog file it’s an open-source project under MIT License. Have a simple but powerful structure and keep tracking of everything I need.

Most common types of changes

  • Added for new features.
  • Changed for changes in existing functionality.
  • Deprecated for soon-to-be removed features.
  • Removed for now removed features.
  • Fixed for any bug fixes.
  • Security in case of vulnerabilities.
  • Unreleased for undeployed.

Newsletter


Related Posts

Get your Jenkins Passwords from secrets

How to get your Jenkins passwords from your secrets credentials. Follow this simple tutoriale and find your password or ssh private key.

How to launch a 6 figures startup with 0$ investment

Are you curious how to launch a startup in the fast and effective way? Here's not the answer, but you can understand how to achieve it

How to cold email

How to cold email - a practical guide about how to use cold email in your activity as a CEO of a software agency or startup owner.

Linux disk space alerts on Discord

Linux disk space alerts. Check your space and be responsible with your project. Take care of your space and don't crack the project.

Git clone private repo in docker

A simple how to guide to use git clone of a private repository inside docker container. With vuejs / nodejs app.

How to detect the browser language in javascript

How to detect the browser language in javascript in just a line of code. The method is working on all major browser

You don't need a macbook pro to be a pro

You don't need a macbook pro to be a pro! You need a laptop and internet connection, and a brain, but you already have it

Free templates for startup

Free HTML templates for startup or a new project. A complete list with free resources to build your next startup's website and gain the traction to the sky.

What I learned to never do in a presentation meeting

What I learned to never do in a presentation meeting. I had a very bad meeting experience with a gateway provider.

Startup graveyard is a series of killed projects that made millions in revenue per year

Startup graveyard is a series of killed projects that made millions in revenue per year. Just watch their graveyard and do it your own. What better validation do you expect.