1
0
mirror of https://github.com/golang/go synced 2024-11-05 15:56:12 -07:00
go/doc
Giovanni Bajo a3d8326993 doc: first version of new contribute guide
I've reorganized the guide and rewritten large sections.

The structure is now more clear and logical, and can
be understood and navigated using the summary displayed at
the top of the page (before, the summary was confusing because
the guide contained H1s that were being ignored by the summary).

Both the initial onboarding process and the Gerrit
change submission process have been reworked to
include a concise checklist of steps that can be
read and understood in a few seconds, for people
that don't want or need to bother with details.
More in-depth descriptions have been moved into
separate sections, one per each checklist step.
This is by far the biggest improvement, as the previous
approach of having to read several pages just to understand
the requires steps was very scaring for beginners, in
addition of being harder to navigate.

GitHub pull requests have been integrated as a different
way to submit a change, suggested for first time contributors.

The review process has been described in more details,
documenting the workflow and the used conventions.

Most miscellanea have been moved into an "advanced
topics" chapter.

Paragraphs describing how to use git have been removed
to simplify reading. This guide should focus on Go contribution,
and not help users getting familiar with git, for which many
guides are available.

Change-Id: I6f4b76583c9878b230ba1d0225745a1708fad2e8
Reviewed-on: https://go-review.googlesource.com/93495
Reviewed-by: Rob Pike <r@golang.org>
2018-03-22 10:24:44 +00:00
..
articles doc/articles/wiki: highlight the use of _ warning 2018-02-14 04:54:37 +00:00
codewalk all: make copyright headers consistent with one space after period 2016-05-02 13:43:18 +00:00
devel all: remove "the" duplications 2018-02-18 17:54:20 +00:00
gopher website: recreate 16px and 32px favicon 2016-08-25 15:43:32 +00:00
play doc/play: update URL for concurrent pi 2016-01-06 20:23:21 +00:00
progs net/http,doc: use HTTP status code constants where applicable 2018-02-26 05:04:31 +00:00
asm.html doc: s/tool chain/toolchain/ 2018-01-09 21:47:03 +00:00
cmd.html doc: website: changed link for cover 2017-06-18 16:19:31 +00:00
code.html doc: Proper default value for the $GOPATH. 2017-06-28 05:47:47 +00:00
conduct.html doc: remove Sarah Adams from conduct working group contacts 2018-01-25 17:27:24 +00:00
contrib.html doc/contrib.html: fix outdated link 2017-12-11 22:15:38 +00:00
contribute.html doc: first version of new contribute guide 2018-03-22 10:24:44 +00:00
debugging_with_gdb.html doc: remove interior <code> spaces in debugging, diagnostics docs 2018-01-09 21:48:03 +00:00
diagnostics.html all: restore changes from faulty merge/revert 2018-02-12 20:13:59 +00:00
docs.html doc: fix a sentence position. 2017-11-25 17:06:50 +00:00
editors.html doc/editors: remove feature matrix for various editors/IDEs 2018-02-05 18:37:02 +00:00
effective_go.html doc: fix typo in Effective Go: s/ReaderWriter/ReadWriter/ 2017-11-23 04:07:39 +00:00
gccgo_contribute.html doc: fix stale gofrontend/gccgo contribution link 2016-09-01 18:38:38 +00:00
gccgo_install.html doc: update GCC release info in gccgo_install 2017-10-03 14:33:14 +00:00
go1.1.html doc: s/tool chain/toolchain/ 2018-01-09 21:47:03 +00:00
go1.2.html doc: s/tool chain/toolchain/ 2018-01-09 21:47:03 +00:00
go1.3.html doc: s/tool chain/toolchain/ 2018-01-09 21:47:03 +00:00
go1.4.html doc/go1.4.html: fix typo 2015-03-24 18:17:49 +00:00
go1.5.html doc: mention that go install removes binaries built by go build 2015-09-08 18:46:07 +00:00
go1.6.html doc: GCC 6 will have the Go 1.6.1 user libraries 2016-04-14 20:00:33 +00:00
go1.7.html doc: fix broken links in 1.7 release docs 2016-11-07 18:51:29 +00:00
go1.8.html doc: fix broken link in go1.8.html 2017-02-22 23:51:12 +00:00
go1.9.html doc/1.9: add mention of net/http.LocalAddrContextKey 2017-08-28 19:21:54 +00:00
go1.10.html doc: add note about invalid flag errors to 1.10 release notes 2018-02-16 00:27:49 +00:00
go1.html doc: change anchor URLs from golang.org/dl/ to /dl/ 2018-01-20 04:13:12 +00:00
go1compat.html doc: s/tool chain/toolchain/ 2018-01-09 21:47:03 +00:00
go_faq.html doc/faq: add a Q&A about virus scanners 2018-02-28 05:55:31 +00:00
go_mem.html doc/go_mem.html: correct the channel example 2015-03-16 21:43:31 +00:00
go_spec.html Revert "doc: remove non-prime from list of primes in spec" 2018-03-19 21:51:23 +00:00
go-logo-black.png doc: pngcrush and remove old, unused images 2012-03-08 14:18:28 +11:00
go-logo-blue.png doc: pngcrush and remove old, unused images 2012-03-08 14:18:28 +11:00
go-logo-white.png doc: pngcrush and remove old, unused images 2012-03-08 14:18:28 +11:00
help.html doc: hide content blocked by GFW when served in CN 2017-09-11 14:59:59 +00:00
ie.css
install-source.html doc: add GOMIPS to source installation docs 2018-01-30 19:54:01 +00:00
install.html doc: change anchor URLs from golang.org/dl/ to /dl/ 2018-01-20 04:13:12 +00:00
root.html doc: change anchor URLs from golang.org/dl/ to /dl/ 2018-01-20 04:13:12 +00:00
security.html doc: dissuade people from using PGP for security reports 2017-04-17 18:33:08 +00:00
share.png godoc: change link styles, add 'pop out' button 2012-03-13 11:00:11 +11:00
tos.html doc: drop scheme from links that are known to support HTTPS 2014-07-25 10:28:39 +10:00