GNU Astronomy Utilities - Tasks: task #13779, Drop ChangeLog
You are not allowed to post comments on this tracker with your current authentication level.
task #13779: Drop ChangeLog
Submitter: | Mosè Giordano <giordano> | ||
Submitted: | Fri 16 Oct 2015 02:44:28 PM UTC | ||
Should Start On: | Thu 15 Oct 2015 10:00:00 PM UTC | Should be Finished on: | Thu 15 Oct 2015 10:00:00 PM UTC |
Category: | None | Priority: | 5 - Normal |
Item Group: | None | Status: | Postponed |
Privacy: | Public | Assigned to: | makhlaghi |
Percent Complete: | 100% | Open/Closed: | Closed |
Effort: | 0.00 |
Jump to the original submission
Fri 27 May 2016 04:37:57 AM UTC, comment #6: |
Mohammad Akhlaghi <makhlaghi> |
Sat 30 Apr 2016 08:14:41 AM UTC, comment #5: At the start of the bootsrap script (from Gnulib). It suggests: "consider installing git-merge-changelog from gnulib". After searching for "changelog" in gnulib, I saw there is also another script: "gitlog-to-changelog". These might also be interesting alternatives, besides the emacs solution. Since they are in Gnulib, it might be easier to use in Gnuastro. But it would be interesting to do a nice comparison and see how they all work and make the best choice. |
Mohammad Akhlaghi <makhlaghi> |
Sat 07 Nov 2015 06:29:32 PM UTC, comment #4: I'd suggest to completely drop the ChangeLog like GSL, but of course continuing to describe as much as possible the changeset in the commit message. git blame is a wonderful tool to inspect the history of a region of code.
|
Mosè Giordano <giordano> |
Sat 07 Nov 2015 03:13:54 AM UTC, comment #3: Thanks for the link. From now on, we can stop adding to the ChangeLog. I have just added a "For v0.1:" to the title to explicitly mark this task as something that should be done before the release of version 0.1. In this way, a simple search in the open tasks will highlight anything we haven't done yet.
|
Mohammad Akhlaghi <makhlaghi> |
Wed 04 Nov 2015 10:55:01 AM UTC, comment #2: ChangeLog file can be auto-generated from VCS log, this is what Emacs does (http://git.savannah.gnu.org/gitweb/?p=emacs.git;a=blob;f=build-aux/gitlog-to-changelog;hb=HEAD). Instead, GSL completely dropped ChangeLog three years ago.
|
Mosè Giordano <giordano> |
Wed 04 Nov 2015 08:22:04 AM UTC, comment #1: This is a completely reasonable argument and I agree. Until now I would only keep the changes (as opposed to additions) in the ChangeLog and try to explain both in the commit messages.
|
Mohammad Akhlaghi <makhlaghi> |
Fri 16 Oct 2015 02:44:28 PM UTC, original submission:
ChangeLog files used to make sense whit old VCSs, but modern VCSs, like git, have good commit messages and writing both the commit message and the ChangeLog is a duplicate effort. Working with other people results often in high probability of having merge conflicts on ChangeLog, which are a pain to fix. I suggest, but this is open to discussion, to drop the ChangeLog and continue to have informative commit messages instead. |
Mosè Giordano <giordano> |
No files currently attached
Depends on the following items: None found
Items that depend on this one: None found
There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.
Follow 6 latest changes.
Date | Changed by | Updated Field | Previous Value | => | Replaced by |
---|---|---|---|---|---|
2016-05-27 | makhlaghi | Percent Complete | 10% | 100% | |
Open/Closed | Open | Closed | |||
Summary | For v0.1: drop ChangeLog | Drop ChangeLog | |||
2015-11-07 | makhlaghi | Percent Complete | 0% | 10% | |
Assigned to | None | makhlaghi | |||
Summary | Drop ChangeLog? | For v0.1: drop ChangeLog |
Powered by Savane 3.13-f8d8.
Corresponding source code
An explanation was added to the ChangeLog (so if someone opens the existing ChangeLog they know that it is no longer being updated) to finish this task. It has been merged into master and thus this task is now complete.
Two new tasks were defined following the completion of this task: task #14007 (to automatically generate the ChangeLog from the version controlled history) and task #14008 (to discuss if it is good to adopt the ChangeLog formatting in the commit messages).