code review 180075: make it more explicit that design discussions should ha...

make it more explicit that design discussions should happen before code reviews

[r, 2009-12-17 00:53:59]

Hello rsc (cc: golang-dev@googlegroups.com),

I'd like you to review the following change.

[gri1, 2009-12-17 00:56:12]

LGTM

On Wed, Dec 16, 2009 at 4:53 PM, <r@golang.org> wrote:

> Reviewers: rsc,
>
> Message:
> Hello rsc (cc: golang-dev@googlegroups.com),
>
> I'd like you to review the following change.
>
>
> Description:
> make it more explicit that design discussions should happen before code
> reviews
>
> Please review this at http://codereview.appspot.com/180075
>
> Affected files:
>  M doc/code.html
>  M doc/contribute.html
>
>
> Index: doc/code.html
> ===================================================================
> --- a/doc/code.html
> +++ b/doc/code.html
> @@ -12,10 +12,11 @@
>  <p>
>  Before embarking on a change to an existing
>  package or the creation of a new package,
> -it's a good idea to send mail to the <a href="
> http://groups.google.com/group/golang-nuts">mailing list</a>
> +be sure to send mail to the
> +<a href="http://groups.google.com/group/golang-nuts">mailing list</a>
>  to let people know what you are thinking of doing.
>  Doing so helps avoid duplication of effort and
> -enables discussions about design before much code
> +enables discussions about design before any code
>  has been written.
>  </p>
>
> Index: doc/contribute.html
> ===================================================================
> --- a/doc/contribute.html
> +++ b/doc/contribute.html
> @@ -11,6 +11,24 @@
>  see <a href="gccgo_contribute.html">Contributing to gccgo</a>.)
>  </p>
>
> +<h2 id="Design">Discuss your design</h2>
> +
> +<p>
> +The project welcomes submissions but please let everyone know what
> +you're working on if you want it to become part of the main repository.
> +</p>
> +
> +<p>
> +Before undertaking to write something new for the Go project, send
> +mail to the <a href="http://groups.google.com/group/golang-nuts">mailing
> +list</a> to discuss what you plan to do.  This gives everyone a
> +chance to validate the design, helps prevent duplication of effort,
> +and ensures that the idea fits inside the goals for the language
> +and tools.  It also guarantees that the design is sound before code
> +is written; the code review tool is not the place for high-level
> +discussions.
> +</p>
> +
>  <h2 id="Testing">Testing redux</h2>
>
>  <p>
>
>
>

[rsc, 2009-12-17 01:10:08]

LGTM

[r, 2009-12-17 01:12:51]

*** Submitted as http://code.google.com/p/go/source/detail?r=82302bbf4cc3 ***

make it more explicit that design discussions should happen before code reviews

R=rsc
CC=golang-dev
http://codereview.appspot.com/180075