[tahoe-lafs-trac-stream] [Tahoe-LAFS] #3706: Create documentation for requesting design review

[Tahoe-LAFS]

#3706: Create documentation for requesting design review
-------------------------+------------------------------------
     Reporter:  maylee   |      Owner:  maylee
         Type:  defect   |     Status:  new
     Priority:  normal   |  Milestone:  Contributor Experience
    Component:  unknown  |    Version:  n/a
   Resolution:           |   Keywords:
Launchpad Bug:           |
-------------------------+------------------------------------

Comment (by exarkun):

 > Would linking to the following be suitable, or should we have something
 more specific to the organization?

 I don't think the Wikipedia page helps much.  Sorry I wasn't more clear
 with my comment, I probably should have just saved it for a more
 reasonable hour.

 Here's what I really meant.  If the developer guide says you can have a
 "design review" it should explain what that actually means.  What is a
 "design" and what constitutes a review of it?  The vague Wikipedia page
 doesn't answer either of these questions.  It talks about the vague notion
 of what design in software is but you can't read that page and then create
 a software design.  *My* suspicion is that this idea is just too abstract
 to actually be useful.  Instead, it's just an extra barrier to
 contribution (either the barrier of more docs to read and remember before
 you can contribute or a barrier in actually trying to produce such a
 design).

 I'm 100% supportive of doing specifications where they are helpful (eg, to
 have a normative definition of behavior that is not just a reference
 implementation).  A "specification" has at least one critical, concrete
 attribute which we can point at and use for evaluation: either it tells
 you everything necessary to create an implementation or it does not.

 My first comment about having a definition of "design" was aimed at this.
 What is at least one concrete attribute about "a design" design and say
 "yes this document has it" or "no this document does not have it"?  A list
 of such attributes would be the "definition" I was asking for.

--
Ticket URL: <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/3706#comment:4>
Tahoe-LAFS <https://Tahoe-LAFS.org>
secure decentralized storage