DIP document maintenance

[Dicebot via Digitalmars-d-announce]

On 11/17/2016 04:36 PM, Andrei Alexandrescu wrote:
> On 11/17/2016 09:16 AM, Dicebot wrote:
>> 2) It is a regular update. In that case revision number is simply git
>> history. For example DIP1002 is currently at revision 7 (git log
>> --pretty=oneline DIPs/DIP1002.md | wc -l).
>>
>> Same goes for update of reviews - everything is tracked in git history.
>> At any given point of time you simply throw away everything old and keep
>> only most recent versions.
> 
> OK, so we're just using git for versioning, which should work fine. The
> one potential issue I see with it is the version number is not
> indicative of how many review cycles have been passed. E.g. DIP1002 is
> already at revision 7, which is an irrelevant number to the casual
> reader. "What do you think of DIP2749?" "Which revision you mean?" "Well
> it's revision 38." "Would that be before or after the third review?" etc.

Hm, my understanding was that there are not supposed to be multiple
formal reviews. Either DIP is marked with "Information Requested" and
mentions informal checklist of improvements to be done, or it actually
undergoes final judgment and there is only way to "Approved" or
"Rejected" from there.

If you want to incorporate multiple iterations, some adjustments may
indeed be necessary.

> I'd like to have a simple tag a la DIP2749 v1 for the first review
> round, DIP2749 v2 for the second review round, and so on. So then people
> can refer to "DIP2749 v3" in casual conversation. Is this feasible?

Yes. Assuming you do want multiple review iterations support, I can
imagine something like this:

- new "review candidate #" field is added to the header
- it is set to 0 on initial merge and to 1 after incorporating initial
NG feedback
- it also references specific DIP version hash matching time of
incrementing the version
- changes to DIP are made in a regular manner. When author is done, rc #
is incremented and hash gets updated
- included reviews refer to specific rc #

If that sounds good, I'll make a PR to update README and ping you from
there.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 455 bytes
Desc: OpenPGP digital signature
URL: <http://lists.puremagic.com/pipermail/digitalmars-d-announce/attachments/20161117/00f6a441/attachment.sig>