[ruby-core:75434] [Ruby trunk Misc#12283] Obsolete ChangeLog and commit message in Git-style

Issue #12283 has been updated by Robert A. Heiler.


I personally have no preference either way.

I should however had also note that I like the current changelog format:

  https://github.com/ruby/ruby/blob/trunk/ChangeLog

It sort of is easy for me to read what is new, what is changed, what
is being worked on etc...

For me who is more or less a casual ruby user, writing mostly just ruby
code, it allows me to keep track of that in a very easy manner.

>> Matz agreed with this proposal, provided that a ChangeLog-like plain-text file is generated from the commit log.

> I don't even think that's necessary; NEWS file with pointers to
> SVN/git history is enough.

I like the changelogs more than the NEWS file - I don't even look
at the news file much at all, easier to keep track of current 
changes as they happen. :-)


----------------------------------------
Misc #12283: Obsolete ChangeLog and commit message in Git-style
https://bugs.ruby-lang.org/issues/12283#change-58551

* Author: Yui NARUSE
* Status: Open
* Priority: Normal
* Assignee: 
----------------------------------------
How about Git-style commit message instead of ChangeLog?

## Proposal

After we reach the consensus

1. Write a commit message in Git-style.

  * Line 1: summary of commit (around 80 characters or less, <50 is better)
  * Line 2: empty line
  * Line 3-: More detailed explanation of commit

See also: https://git-scm.com/book/ch5-2.html#Commit-Guidelines

2. Stop manually edit ChangeLog and auto-generate on `make dist`.

## Rationale

A good commit message should include the objective of the commit.
Committers should write "what purpose the change is for".
In this sense, ChangeLog is not a good format.  It lists per-file changes, so committers tend to write just "how the files were changed".

Also, ChangeLog causes commit conflicts frequently.
Though it is not related with the actual commit.
People who uses svn/git should see the log with it; ChangeLog is only for tarball users.

## Status

mame made this proposal at the developers' meeting (13 Apr.), and there was no objection.

Matz agreed with this proposal, provided that a ChangeLog-like plain-text file is generated from the commit log.
The release manager will create the file when Ruby is released.

### Note

This ticket does NOT propose a migration from SVN to Git.  Never discuss that in this ticket.



-- 
https://bugs.ruby-lang.org/

Unsubscribe: <mailto:[e-mail]?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>