Please considering adding a CHANGELOG.md file to the project #304

Closed
tdm00 opened this Issue Apr 4, 2013 · 3 comments

Comments

Projects
None yet
3 participants
@tdm00

tdm00 commented Apr 4, 2013

Please considering adding a CHANGELOG.md file to the project to help tracking major and minor changes to the project. Going through each commit in the history is pretty time consuming to try and get this overview.

Thank you for your consideration

@mislav

This comment has been minimized.

Show comment Hide comment
@mislav

mislav Apr 4, 2013

Owner

Nope. I maintain a CHANGELOG in some other projects that I have (or have adopted) and I find it very cumbersome to update with every commit. I wish I wasn't doing it. In the end, git log is the best changelog. I understand that it's sometimes hard to see what's going on in it, but it can help you a great deal to use a couple options to filter things out like merge commits or commits that don't deal with any changes to functionality. Below I only scope the log to the contents of lib/ directory.

git log --no-merges --date=short \
  --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cd)%Creset' \
  -- lib
Owner

mislav commented Apr 4, 2013

Nope. I maintain a CHANGELOG in some other projects that I have (or have adopted) and I find it very cumbersome to update with every commit. I wish I wasn't doing it. In the end, git log is the best changelog. I understand that it's sometimes hard to see what's going on in it, but it can help you a great deal to use a couple options to filter things out like merge commits or commits that don't deal with any changes to functionality. Below I only scope the log to the contents of lib/ directory.

git log --no-merges --date=short \
  --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cd)%Creset' \
  -- lib

@mislav mislav closed this Apr 4, 2013

@jrmehle

This comment has been minimized.

Show comment Hide comment
@jrmehle

jrmehle Apr 4, 2013

No complaints, just wanted to say this works really well as a git alias

Add the following to your ~/.gitconfig:

      changelog = log -n25 --no-merges --date=short --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cd)%Creset' -- lib

I've added the -n25 to show only the last 25 commits because on larger projects it doesn't behave as well. Alter the number as you see fit or remove it.

jrmehle commented Apr 4, 2013

No complaints, just wanted to say this works really well as a git alias

Add the following to your ~/.gitconfig:

      changelog = log -n25 --no-merges --date=short --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cd)%Creset' -- lib

I've added the -n25 to show only the last 25 commits because on larger projects it doesn't behave as well. Alter the number as you see fit or remove it.

@tdm00

This comment has been minimized.

Show comment Hide comment
@tdm00

tdm00 Apr 5, 2013

Thanks for the alias. This will require me to have a copy of the repo to
find out this information and keep it updated, unlike the other gems I use
that I just read the CHANGELOG file.

On Thursday, April 4, 2013, Jared Mehle wrote:

No complaints, just wanted to say this works really well as a git alias

Add the following to your ~/.gitconfig:

[alias]
changelog = log -n25 --no-merges --date=short
--pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s
%Cgreen(%cd)%Creset' -- lib

I've added the -n25 to show only the last 25 commits because on larger
projects it doesn't behave as well. Alter the number as you see fit or
remove it.


Reply to this email directly or view it on GitHubhttps://github.com/mislav/will_paginate/issues/304#issuecomment-15925610
.

Troy Murray

tdm00 commented Apr 5, 2013

Thanks for the alias. This will require me to have a copy of the repo to
find out this information and keep it updated, unlike the other gems I use
that I just read the CHANGELOG file.

On Thursday, April 4, 2013, Jared Mehle wrote:

No complaints, just wanted to say this works really well as a git alias

Add the following to your ~/.gitconfig:

[alias]
changelog = log -n25 --no-merges --date=short
--pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s
%Cgreen(%cd)%Creset' -- lib

I've added the -n25 to show only the last 25 commits because on larger
projects it doesn't behave as well. Alter the number as you see fit or
remove it.


Reply to this email directly or view it on GitHubhttps://github.com/mislav/will_paginate/issues/304#issuecomment-15925610
.

Troy Murray

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