[buddypress-trac] [BuddyPress Trac] #6642: BP Template Versioning

[buddypress-trac]

#6642: BP Template Versioning
-----------------------------------------+------------------
 Reporter:  hnla                         |       Owner:
     Type:  enhancement                  |      Status:  new
 Priority:  normal                       |   Milestone:  2.4
Component:  Appearance - Template Parts  |     Version:
 Severity:  minor                        |  Resolution:
 Keywords:  dev-feedback                 |
-----------------------------------------+------------------

Comment (by DJPaul):

 Putting a version history/changelog in the template files is a good idea
 regardless of anything else.

 From the British peanut gallery:

 * I don't think that `@internal` is the right phpDoc property to use. It
 kind of makes sense, but (I believe) anything applied at the file-level is
 cascaded down to classes and functions within that file. Most parsers,
 especially WP-Parser, will filter out `@internal` content when creating
 HTML output (or whatever) -- meaning these files' contents would just not
 appear in any auto-generated documentation. I think `@since` is better and
 more semantically correct. Otherwise, make up a custom tag.
  * Source:
 http://www.phpdoc.org/docs/latest/references/phpdoc/tags/internal.html
 * I do not like the idea of distributing a JSON file, acting as a
 changelog, in BP core. One reason is that I see no reason why it couldn't
 just be PHP. A second reason is that a JSON file adds significant
 complication to our translation workflow which has not been addressed in
 the proposals.
 * I share Boone's concerns about being very careful to only show this to
 developers. I'm not convinced by all the arguments in the "the benefits"
 section (showing it to end users, for example, or how it will help "us"
 core developers in future).
 * I think the goal of what this change is trying to achieve needs to be
 more focused. In the screenshot on this ticket, it says "please upgrade
 (the) template":
  * What happens if I don't want to, or can't? Can/should I be able to
 dismiss the errors?
  * To help a person decide if something's important, I would want to know
 three things:
   * What (is the problem?)
   * Why (should I care or do something about it?)
   * How (do I make that change?)
  * Therefore, have you considered the different importance of changes? Do
 we present (for example) the addition of ARIA attributes in the same way
 that we would do if we were to make significant HTML changes? Do we need
 to show all messages all the time?

--
Ticket URL: <https://buddypress.trac.wordpress.org/ticket/6642#comment:6>
BuddyPress Trac <http://buddypress.org/>
BuddyPress Trac