W3C home > Mailing lists > Public > www-archive@w3.org > February 2013

Putting version control changelog links in spec

From: L. David Baron <dbaron@dbaron.org>
Date: Wed, 13 Feb 2013 13:44:09 -0800
To: w3c-css-wg@w3.org
Cc: www-archive@w3.org
Message-ID: <20130213214409.GA6184@crum.dbaron.org>
One piece of feedback I got, in
https://twitter.com/SimeVidas/status/301524101674192897 , was that
it was great to see a ChangeLog in a spec.  (This is linked from a
well-hidden part of
http://www.w3.org/TR/2013/WD-css3-transitions-20130212/#status but
was also more prominent in
http://lists.w3.org/Archives/Public/www-style/2013Feb/0330.html .

(Amusingly enough, I actually realized I should update it before
publishing; typically only the Apple folks update the ChangeLog
file; I'd much rather not have a ChangeLog file since they just
duplicate what's in the version control system and increase the
chance of getting it wrong.)


I think that we should perhaps make it a practice to link from the
spec to its history in version control.  In other words, we could
link from the transitions spec to either:
https://dvcs.w3.org/hg/csswg/log/tip/css3-transitions/Overview.src.html
or to the revision-specific version of it.  We could do this in a
parenthetical after the Editor's draft link in the header, or
further down (in the status of this document section, or in a
changes section).

Thoughts?

-David

-- 
𝄞   L. David Baron                         http://dbaron.org/   𝄂
𝄢   Mozilla                           http://www.mozilla.org/   𝄂
Received on Wednesday, 13 February 2013 21:44:39 GMT

This archive was generated by hypermail 2.2.0+W3C-0.50 : Wednesday, 13 February 2013 21:44:40 GMT