Skip to content

Change logs with more meaningful information #1653

Description

@edusantana

This repository Changelog only contains "Closed issues" and "Merged pull requests".

Sometimes, we look for more meaningful information. This website https://keepachangelog.com/en/1.0.0/ suggests a different way to write a changelog, with 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.

I used to use this codelog tool in a Brazilian project I maintained -- text will be in Portuguese.

The setup is pretty easy:

gem install codelog # no need to add to Gemfile
codelog setup

Add to Rakefile:

desc "Create a new codelog entry. See https://github.com/codus/codelog/blob/master/README.md#usage"
task 'codelog:new', [:feature] do |t, args|
  system 'codelog', 'new', args[:feature]
end

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions