From 5b72f9cd0ba7dc520b65b204c56b9fed6a35f687 Mon Sep 17 00:00:00 2001 From: Rob Pike Date: Sun, 1 Nov 2009 20:48:21 -0800 Subject: [PATCH] save some text from the old FAQ; will get reworked in time R=rsc http://go/go-review/1018008 --- doc/contribute.html | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/doc/contribute.html b/doc/contribute.html index 80aac32ead7..8ab7e0d2238 100644 --- a/doc/contribute.html +++ b/doc/contribute.html @@ -1,6 +1,36 @@ -TODO(go-dev): Write this document. +

TODO(go-dev): Write this document

+ +

Have to work on the tools first. +

+Text previously from the FAQ placed here for safekeeping. +

    +
  1. If it's a significant change, discuss on the mailing list before embarking. + +
  2. Check out the Go source code files. The library sources are in go/src/pkg. + +
  3. Make changes; add tests as appropriate. Try to follow existing style, + including tabs for indentation, and no trailing whitespace. In + documentation comments for public declarations, use full sentences + and begin with the name of the thing being described, because godoc + (or other tools) may someday display these comments out of context. + +
  4. Write the Makefile by following existing examples. + +
  5. Run make and make test in the affected + directories. + +
  6. If you have added a new dependency, you may need to cd go/src/lib; + ./deps.bash to update the Make.deps file included in the Makefile. + For a new component, update the Makefile and then run + deps.bash. +
  7. cd go/src; ./all.bash + +
  8. Once all.bash succeeds (output like + "N known bugs; 0 unexpected bugs" is OK), + submit a CL. +