diff options
author | Rob Pike <r@golang.org> | 2009-11-01 20:48:21 -0800 |
---|---|---|
committer | Rob Pike <r@golang.org> | 2009-11-01 20:48:21 -0800 |
commit | d9177dc0ebe014745d45bb60c4ed0a7cfd7f66bd (patch) | |
tree | e990c5dd6e33177b4a770708a97e437f9ff480b0 /doc/contribute.html | |
parent | a8083fe5b46f6b4b3a9e8246e2669d57790b8938 (diff) | |
download | go-d9177dc0ebe014745d45bb60c4ed0a7cfd7f66bd.tar.gz |
save some text from the old FAQ; will get reworked in time
R=rsc
http://go/go-review/1018008
Diffstat (limited to 'doc/contribute.html')
-rw-r--r-- | doc/contribute.html | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/doc/contribute.html b/doc/contribute.html index 80aac32ea..8ab7e0d22 100644 --- a/doc/contribute.html +++ b/doc/contribute.html @@ -1,6 +1,36 @@ <!-- Contributing to the Go project --> -TODO(go-dev): Write this document. +<h2 id="TODO">TODO(go-dev): Write this document</h2> + +<p> Have to work on the tools first. +<p> +Text previously from the FAQ placed here for safekeeping. + +<ol> +<li>If it's a significant change, discuss on the mailing list before embarking. + +<li>Check out the Go source code files. The library sources are in <code>go/src/pkg</code>. + +<li>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. + +<li>Write the <code>Makefile</code> by following existing examples. + +<li>Run <code>make</code> and <code>make test</code> in the affected + directories. + +<li>If you have added a new dependency, you may need to <code>cd go/src/lib; + ./deps.bash</code> to update the Make.deps file included in the Makefile. + For a new component, update the <code>Makefile</code> and then run + <code>deps.bash</code>. +<li><code>cd go/src; ./all.bash</code> +<li>Once <code>all.bash</code> succeeds (output like + "N known bugs; 0 unexpected bugs" is OK), + <a href="/doc/contribute.html">submit a CL</a>. +</ol> |