WordPress.org

Make WordPress Core

Opened 6 years ago

Last modified 3 months ago

#22810 new enhancement

Support for theme changelogs

Reported by: Daedalon Owned by:
Milestone: Future Release Priority: normal
Severity: normal Version:
Component: Themes Keywords:
Focuses: Cc:

Description (last modified by scribu)

Plugins' changelogs are shown in the WordPress plugin repository in tabs, eg. http://wordpress.org/extend/plugins/events-manager/changelog/.

Plugins' changelogs are also linked to when viewing available updates in WP-admin, so the siteadmins can know if the update could mess with their customizations.

Theme changelogs are not visible in either place. They should be supported in both places. Also http://codex.wordpress.org/Theme_Review should be updated to reflect that the theme changelogs are much recommended if not mandatory to use and to specify the exact format for them. Currently it uses language that is not clear for those who don't speak English as their first language: "In lieu of..." and then "...Themes are recommended to include a changelog", which doesn't let the theme author know what format should the changelog be in.

At the moment I've seen changelogs for themes in different formats, but none of them is supported.

Summary of the issues:

  1. Add support for theme changelogs on https://wordpress.org/extend/themes/ theme pages in tabs.
  2. Add support for theme changelogs in wp-admin theme list views.
  3. Clarify Theme Review codex page on the supported format(s) and use more simple English than "in lieu of".

Change History (15)

#1 @scribu
6 years ago

  • Keywords 3.6-early added
  • Type changed from defect (bug) to enhancement

+1 on all 3 proposals.

#2 @scribu
6 years ago

  • Description modified (diff)
  • Milestone changed from Awaiting Review to Future Release

#3 @sabreuse
6 years ago

  • Cc sabreuse added

#4 @sabreuse
6 years ago

+1 to support for changelogs in extend and the admin -- but note that changes to the Theme Review Guidelines, as well as any language suggestions, should be brought up over at http://make.wordpress.org/themes

#5 @lancewillett
5 years ago

  • Cc lancewillett added

#6 @mario-siteground
5 years ago

The part for the WordPress.org website has been reported in the Meta Trac as well.

#7 @Daedalon
4 years ago

Sabreuse, thanks for the tip. What other ways are there to bring this to the discussion of the Theme Review Team besides joining a mailing list (which we won't do to avoid spam), IRC (not suitable) or commenting on an unrelated topic on the blog (not appropriate)?

Their Trac seems to be only for reviewing themes and they don't accept new tickets by the community related to the theme process in general. It stands to reason that this and other issues are still open as there's no way for the community to initiate discussion without subscribing to a mailing list. People like us who want to contribute suggestions without getting spammed with all discussions don't currently have a way to contribute.

As it stands, the TRT is a semi-closed circle for us.

Ironically, the officially proper place for this comment would probably be the mailing list, which isn't applicable for the above reasons. Hopefully someone would pick this up from here or suggest a viable alternative.

#8 @markoheijnen
4 years ago

IRC would be the best way I guess. Also you can create a new e-mail account for mailing lists. In this case contributing back would mean adding code to WordPress.org and not to core. I would not say it's sem-closed because you can join the mailinglist or IRC if you want.

Also Mario mentioned the Trac of the Meta team. That is focussed on things related to WordPress.org.

#10 @usability.idealist
3 years ago

Because this was suggested to take up in the Theme Review "blog" - after reading through all of this, the question arises: If none of the used changelog formats work - WHAT is the actual expected one? Markdown?

In the case of Markdown, all would be easy. Just simple lists, with h2 or h3 headlines in between to section each release .. and end of story.

And because lots of folks already use Github and other stuff .. no real transition needed ;)

cu, w0lf.

Last edited 3 years ago by usability.idealist (previous) (diff)

This ticket was mentioned in Slack in #themereview by jcastaneda. View the logs.


3 years ago

#12 @jcastaneda
3 years ago

  • Keywords 3.6-early removed

As it stands, the TRT is a semi-closed circle for us.

Never closed. :) Always welcome!

Ironically, the officially proper place for this comment would probably be the mailing list,

Not anymore, we did away with that. We now use Slack and our blog for communication.

We're taking a second look at using the readme format used by plugins and using only those parts that would benefit themes. Just glad there is some overlap between the two. :) That discussion is: https://make.wordpress.org/themes/2015/04/29/a-revised-readme/

#13 @Daedalon
3 years ago

Great to hear of the developments regarding both this ticket and TRT's reachability!

This ticket was mentioned in Slack in #themereview by jcastaneda. View the logs.


2 years ago

This ticket was mentioned in Slack in #themereview by jcastaneda. View the logs.


3 months ago

Note: See TracTickets for help on using tickets.