What’s a changelog?

The changelog is used to keep track of the changes in the plugin introduced in Maintenance Release or Feature releases, they are useful to indicate what things have been changed or added to the plugin. Are usually included inside readme.txt file of the plugins.

Top ↑


You can take a look at the reference used inside the repository of TEC plugin

== Changelog ==

= [] 2018-04-18 =

* Fix - Fixed fatal error that would sometimes arise when The Events Calendar was set to display on the front page

= [4.6.14] 2018-04-18 =

* Fix - Updated the "front page" logic to store the value in the DB instead of "mocking" the view via JS [100832]
* Fix - Fixed the generation of PHP warnings on retrieval of posts if the "Include events in main blog loop" option is checked (thanks to Colin Carmichael for reporting this problem) [97667]
* Fix - Made the `tribe-ea-record` custom post type (used to store Event Aggregator record information) private [99106]
* Fix - Expanded the size of the time zone input in the admin to allow for better visibility for long names [100363]
* Fix - If the main events page is set to be the site's front page, ensure it shows as "selected" in the Customizer's front page option [100832]
* Fix - Fixed an issue where failed Event Aggregator scheduled imports would re-attempt the import too soon [102489]
* Fix - Ensure the Tribe Bar displays all the available ranges of dates and times [100646]
* Fix - Hid the filters in the Tribe Bar if a unique view is enabled [75114]
* Fix - Fixed some imported-event handling so that events with no time and that aren't all-day events do not display on the front-end [93979]
* Fix - Changed the HTTP status codes of empty event, venue, organizer, category, and tag archives from 404 to 200 and return empty arrays to stick with WP REST API standard [102283]
* Fix - Better "guessing" on column mapping during the import of CSV file (thanks to April in our Help Desk for flagging this problem!) [96162]
* Tweak - Added the `tribe_aggregator_find_matching_organizer` and `tribe_aggregator_find_matching_venue` filters in Events Aggregator to allow the definition of custom Venue and Organizer match criteria [97292]

Top ↑


Every single changelog has the following format:

* Type - Short description (props if applicable) [TICKET-123]

Every entry usually has the format described above, some are optional in some situations.

Top ↑

Format breakdown

*The sentence is always entered with the asterisk sign at the start of the line
TypeTypically this is: Version, Feature, Tweak, Fix, Performance, Security, Accessibility, Compatibility, Deprecated
-Regular no need hyphen for a full not a fancy stop or period em-dash
DescriptionA short description of the change, meaningful for the end users so if no technicality is included is better
(props if applicable)Credit to the users flagging the issue in the Help desk or the WordPress forums
[TICKET-123]Ticket designation from Jira associated with change inside of brackets

Note: Another important consideration is that usually, the description does not have a full stop period.

Top ↑

Order of entries

The following is the list of changelog entry prefixes that we use within our readme.txt files. The order is where the priority of each should be when placing them within a changelog.

  1. Version
  2. Feature
  3. Tweak
  4. Fix
  5. Performance
  6. Security
  7. Accessibility (Use it sparingly for major changes/initiatives. Otherwise Tweak is better)
  8. Compatibility (Use it sparingly for major changes/initiatives. Otherwise Tweak is better)
  9. Deprecated
  10. Language