Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
I pretty much stopped using/updating the CHANGELOG.txt in all of my projects, after having learned some git fu.
Being able to cleanly cherry-pick + merge commits between branches (including topic/feature branches, so not only the primary major version branches) is way more important than the changelog's purpose.
Comments
Comment #1
TwoDI don't mind removing CHANGELOG.txt, I only look at git anyway.
How about doing this in a two-step approach? Step one adds a notice at the top of the file saying it will no longer be updated, along with a link to the commit log or release notes. Step two actually removes the file from the repo.
That should prevent users who do not remove the old Wysiwyg folder before extracting a new release from wondering why the changelog is the same.
Comment #2
sunHm, I don't think we need to care for users who are updating modules incorrectly. :) Let's not make this a huge distraction ;)
I'd suggest to simply go ahead and remove it from all current 2.x branches. The removal clarifies that it is no longer maintained. :)
Comment #3
steinmb CreditAttribution: steinmb commented+1 just remove it. We have git log and for people that don't know/use git - just have to use http://drupal.org/node/181465/commits
Comment #4
TwoDShall we push this to all branches or just the main ones for now?
Comment #5
sunI actually thought some more about this...
Let me propose the following and you tell me whether that makes sense:
#1650416: Allow editor specific changes to be made to the profile settings form - Added "settings form callback" to hook_wysiwyg_editor() for editor-specific settings.
#746524: No Font Styles for CKeditor - Added proper font styles plugin support for CKEditor.
#614146: Drupal.wysiwyg.editor.instance needs additional methods - Added JS editor instance objects with getContent() and setContent() methods.
#1679980: Wysiwyg Dialog code is not ported to D7 at all - Ported dialog code to D7.
In other words, the CHANGELOG.txt contained in the upcoming 7.x-2.2 release will look like this:
The heading for "Wysiwyg 7.x-2.2" is only inserted when a new noteworthy change happens in 2.x-dev (for the future 2.3 release).
That said, maintaining a proper changelog is time-consuming and we're generally lacking time and developer resources in the Wysiwyg project. So while I think that this new proposal would make a lot of sense and provide users a very useful overview of actual changes, I also see and realize that less overhead has a good chance of leading to more progress. This needs to be balanced sensibly.
Comment #6
DamienMcKennaI recommend improving the Best Practices guide as needed and then sticking to that, adhering to a documentation standard will help everyone.
Comment #8
TwoDWe have change records now, let's use that for the major changes and the git history and release notes as usual.