Every time I upgrade my project’s dependencies using and it cannot find a change log I create an issue titled “Add changelog”. Most of them were ignored, sometimes maintainers answer something that means “fuck off”, very rarely they listen. npm-upgrade A good change log answers these questions for the project’s user: What’s the new value for my project in the new version? What are the breaking changes? How can I migrate my codebase to the new version? Were my issues fixed? A change log is a tool that helps you decide to upgrade or not and to evaluate the benefits and the cost of the upgrade. A good change log is: Written for humans, not computers. Understandable by users, not just contributors. Not a Git commit log. Written by a project maintainer — don’t ask for a pull request. You should read this and add a change log to your open source project today. awesome guide

Add the Fucking Change Log

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Automate npm releases with semantic-release and human-written change logs

April Infrastructure Shift Brings May Time On Story Page Lift

Create Great Product Notifications Quickly Using an AI-Powered Content Generator

Kuma 0.7.2 Released

Slogging Editor Updates: New Formatting Added for Bullet Points, Bold, and Italics

This Lightweight Tool Flags Breaking Changes Before You Ship

Automate npm releases with semantic-release and human-written change logs

April Infrastructure Shift Brings May Time On Story Page Lift

Create Great Product Notifications Quickly Using an AI-Powered Content Generator

Kuma 0.7.2 Released

Slogging Editor Updates: New Formatting Added for Bullet Points, Bold, and Italics

This Lightweight Tool Flags Breaking Changes Before You Ship

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps