Problem/Motivation

The file CHANGELOG.txt does not seem to be really useful any more in module's code base.

See related tickets:

Proposed resolution

Remove the file CHANGELOG.txt,

as the release information is readily available on the Drupal.org releases page, so maintaining a separate changelog file may no longer be necessary.

It seems the file was last changed in issue #3079484: Don't track the module changes in the CHANGELOG.txt.

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

dydave created an issue. See original summary.

dydave’s picture

Status: Active » Needs review

I would personally be in favor of removing the file from the code base to align on other "standard" contrib modules.
Less files is also easier to maintain and this file doesn't seem to add any particular information that couldn't be found on the DO project page.

Moving issue to Needs review as an attempt to attract some attention and feedback on the suggested changes.

Thanks in advance!

ressa’s picture

Issue summary: View changes
Status: Needs review » Reviewed & tested by the community
Related issues: +#3244977: Remove CHANGELOG.txt

I agree @dydave, it seems redundant and not adding much value, so great idea with some spring cleaning! The patch works perfectly, and CHANGELOG.txt is deleted.

  • dydave committed 0de4f7d6 on 3.x
    Issue #3524284 by dydave: Removed file 'CHANGELOG.txt'.
    
dydave’s picture

Status: Reviewed & tested by the community » Fixed

Thanks a lot @ressa once again for the prompt and positive feedback! 🙏

This is rather minor, but since we're at it, we might as well try squeezing in as much clean-up as possible before the release 😅
Just like you did with the Admin Toolbar Search settings form path 👍

I personally think the comment linked in the IS to the related issue, sums up very well the different options and removing the file 'CHANGELOG.txt' probably seems like the simplest option for this module right now 🙂 (and for its maintainers 😅)

Following your confirmation, I went ahead and merged the changes above at #5: another issue Fixed for this release 🥳

Let us know if you spot any other "small" changes that could help further polishing the module before its release (in a week🤞), I would certainly be glad to take a closer look very quickly 👌
Thanks again for all the great help reviewing and testing these issues!

ressa’s picture

You're welcome @dydave! And thanks to you as well, for committing yet another improvement, however small -- it all adds up, to making Admin Toolbar a leaner and more manageable unit, since there are fewer elements to keep track of.

Eventually, all these seemingly marginal gains coalesce into having a large cumulative effect, allowing Drupal to really take off 🚀

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.