]> Cypherpunks repositories - gostls13.git/commit
doc: first version of new contribute guide
authorGiovanni Bajo <rasky@develer.com>
Tue, 13 Feb 2018 01:51:23 +0000 (02:51 +0100)
committerGiovanni Bajo <rasky@develer.com>
Thu, 22 Mar 2018 10:24:44 +0000 (10:24 +0000)
commita3d8326993f25869ffb01f27a085abcfabbb42ef
treee67c5ace43667fda554334ea3aa693d410f7d618
parent9eb219480e8de08d380ee052b7bff293856955f8
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>
doc/contribute.html