aboutsummaryrefslogtreecommitdiff
path: root/doc/contribute.html
AgeCommit message (Collapse)Author
2021-02-16doc: remove all docs not tied to distributionRuss Cox
They have moved to x/website in CL 291693. The docs that are left are the ones that are edited at the same time as development in this repository and are tied to the specific version of Go being developed. Those are: - the language spec - the memory model - the assembler manual - the current release's release notes Change-Id: I437c4d33ada1b1716b1919c3c939c2cacf407e83 Reviewed-on: https://go-review.googlesource.com/c/go/+/291711 Trust: Russ Cox <rsc@golang.org> Trust: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
2021-01-01doc: 2021 is the Year of the GopherDmitri Shuralyov
What a year it has been. If there's one thing we can count on at a time like this, it's that 2021 is the Year of the Gopher. Change-Id: I4f6fbbe3d9b4b70df8fadd0d18237f05cd572265 Reviewed-on: https://go-review.googlesource.com/c/go/+/280163 Trust: Dmitri Shuralyov <dmitshur@golang.org> Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Alberto Donizetti <alb.donizetti@gmail.com> Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org> Reviewed-by: Ian Lance Taylor <iant@golang.org>
2020-12-23doc: fix a typo in contribute.htmlAndrey Bokhanko
A fix for a trivial (yet still confusing for neophytes like me!) typo in contribute.html. Change-Id: Ic68673fb2a3855c2b9e8042047087450e8793e6b Reviewed-on: https://go-review.googlesource.com/c/go/+/279452 Reviewed-by: Ian Lance Taylor <iant@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> Run-TryBot: Ian Lance Taylor <iant@golang.org> TryBot-Result: Go Bot <gobot@golang.org>
2020-10-28doc: mention Trust+1 in contribution guideIan Lance Taylor
For #40699 Change-Id: If753a073488880433ae3319dcf2a2dfaa887fd0e Reviewed-on: https://go-review.googlesource.com/c/go/+/259737 Trust: Ian Lance Taylor <iant@golang.org> Trust: Tobias Klauser <tobias.klauser@gmail.com> Reviewed-by: Emmanuel Odeke <emmanuel@orijtech.com> Reviewed-by: Russ Cox <rsc@golang.org>
2020-10-06doc: fix typo in contribute.htmlAlberto Donizetti
Change-Id: Ica27c4a9e4c364d94250aebfc4c2b59cff7f4a8f Reviewed-on: https://go-review.googlesource.com/c/go/+/258679 Trust: Alberto Donizetti <alb.donizetti@gmail.com> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
2020-09-23doc: update overview for authenticationKatie Hockman
The instructions have already been updated in greater detail in "Step 2: Configure git authentication", but the overview needs updated to reflect the new workflow. Change-Id: I6f411a3dc500a9058036a4a828403c0153e4220a Reviewed-on: https://go-review.googlesource.com/c/go/+/256857 Trust: Katie Hockman <katie@golang.org> Run-TryBot: Katie Hockman <katie@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> TryBot-Result: Go Bot <gobot@golang.org>
2020-06-28doc: fix typos and grammatical errors in contribute.htmlJie Ma
Fixed some typos and grammatical errors in contribute.html Change-Id: Ifb31f22d876b7bea84b5e130870c26813b2fa139 GitHub-Last-Rev: 43519198859ca8f5e1c870b8f3eeb1b465aa6bc5 GitHub-Pull-Request: golang/go#39892 Reviewed-on: https://go-review.googlesource.com/c/go/+/240277 Reviewed-by: Ian Lance Taylor <iant@golang.org>
2020-06-05doc: update contribution guide to make it friendlier for x/ reposRebecca Stambler
The current contributor documentation is tailored towards contributors to golang/go, but we have a number of increasingly popular x/ repos. In this CL, I tried to generalize the language to make it apply to any repository. Also, I fixed an old link I noticed in editors.html. Change-Id: Id9d8e448262ed8c3a67f49be5d554ca29df9d3c1 Reviewed-on: https://go-review.googlesource.com/c/go/+/234899 Run-TryBot: Rebecca Stambler <rstambler@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
2020-03-29doc: fix path to make.bashMichał Łowicki
Change-Id: I78c7197b8b93590470a782b492bba177a14d80ec Reviewed-on: https://go-review.googlesource.com/c/go/+/226340 Reviewed-by: Ian Lance Taylor <iant@golang.org>
2020-03-28doc: decrease prominence of GOROOT_BOOTSTRAPGiovanni Bajo
Go build scripts on UNIX (make.bash, all.bash) have not required GOROOT_BOOTSTRAP since August 2017 (CL 57753). Windows build scripts have followed suit since CL 96455. Most people building Go will have a Go toolchain in their PATH and will not need to specify a different toolchain. This CL removes the GOROOT_BOOTSTRAP mention from the contribution guide (it was there for Windows only, but it's not required anymore). The guide is meant to be light and clear for beginners and is not supposed to be a reference, so there's not need to keep mentioning GOROOT_BOOTSTRAP. Also update install-source.html to reflect the current status quo, where using the PATH is probably the first and most used default, and GOROOT_BOOTSTRAP is just an option. Change-Id: Iab453e61b0c749c256aaaf81ea9b2ae58822cb89 Reviewed-on: https://go-review.googlesource.com/c/go/+/224717 Run-TryBot: Giovanni Bajo <rasky@develer.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Rob Pike <r@golang.org>
2020-01-02doc: 2020 is the Year of the GopherDmitri Shuralyov
Starting with 2014 (golang.org/cl/46660043), we have enjoyed 6 consecutive years of the gopher. Now, the slice¹ of gophers is ready to make its way into the next decade, as 2020 is the new Year of the Gopher. ¹ https://en.wikipedia.org/w/index.php?title=List_of_English_terms_of_venery,_by_animal&oldid=932675028#G Change-Id: I5f9598dbedb373bd13021964193fa9e44c67693e Reviewed-on: https://go-review.googlesource.com/c/go/+/213017 Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Josh Bleecher Snyder <josharian@gmail.com> Reviewed-by: David Symonds <dsymonds@golang.org> Reviewed-by: Ian Lance Taylor <iant@golang.org>
2019-07-27doc: use <code> for a few file paths that didn'tDaniel Martí
Spotted while seeing CL 187818 in master. Change-Id: Ic3f42558f6833fc35580b2b2a15f2c5aba5713c0 Reviewed-on: https://go-review.googlesource.com/c/go/+/187822 Reviewed-by: Ian Lance Taylor <iant@golang.org>
2019-07-27doc: mention that GOPATH/bin should be in PATHGiovanni Bajo
As noticed while mentoring at Gophercon, a common mistake for beginners is that, after they install git-codereview, it's not found by git because they haven't put GOPATH/bin in their environment. Change-Id: I885cee0f532a4069d1a17ea27365d54965ecca22 Reviewed-on: https://go-review.googlesource.com/c/go/+/187818 Reviewed-by: Katie Hockman <katie@golang.org>
2019-06-04doc: fix missing anchor links in contribute.htmlAgniva De Sarker
Some <h3>s were missing ids due to which the anchor links weren't getting generated. Fixes #32415 Change-Id: Ica21425c1a7c49735231c1de96b6c77dd594ce64 Reviewed-on: https://go-review.googlesource.com/c/go/+/180397 Reviewed-by: Ian Lance Taylor <iant@golang.org>
2019-04-23doc: update wording in contribution guideBenny Siegert
The top right menu in Gerrit is now a gear icon, and the link has a slightly different title. Change-Id: I3f5d194f31ad09a99416a45db392aa4b5c7d98ff Reviewed-on: https://go-review.googlesource.com/c/go/+/173400 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2019-01-01doc: 2019 is the Year of the GopherJosh Bleecher Snyder
whereas this is a longstanding tradition and insofaras it is worth continuing such traditions and notwithstanding an attempt at future-proofing thetruthofthematter is that I have been waiting for years to send this change so despiteallobjections I have updated the copyright year. Change-Id: I55961b15a7eda35d84fdd9250afdbe19f0bf8412 Reviewed-on: https://go-review.googlesource.com/c/155928 Reviewed-by: Emmanuel Odeke <emm.odeke@gmail.com>
2018-11-01doc: improve language in contributetkivisik
Previous wording was incorrect. Change-Id: I91406c775161d9724ec60824c156e8e9a925bcd7 GitHub-Last-Rev: 2b6b4e136a78a431cc847a2717cbeae4341ed7bc GitHub-Pull-Request: golang/go#28248 Reviewed-on: https://go-review.googlesource.com/c/142879 Reviewed-by: Daniel Martí <mvdan@mvdan.cc>
2018-08-31doc: recommend benchstat for performance commitsRhys Hiltner
The benchstat tool computes statistics about benchmarks, including whether any differences are statistically significant. Recommend its use in commit messages of performance-related changes rather than the simpler benchcmp tool. Change-Id: I4b35c2d892b48e60c3064489b035774792c19c30 Reviewed-on: https://go-review.googlesource.com/132515 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-08-21doc: remove mentions of cloning from GitHubGiovanni Bajo
Complete CL117178 removing all references to GitHub, and leaving a small note to make sure we remember that it's not supported. Change-Id: Id4257515a864875808fa7a67f002ed52cfd635a3 Reviewed-on: https://go-review.googlesource.com/130395 Reviewed-by: Daniel Martí <mvdan@mvdan.cc>
2018-08-08doc/contribute: add examples for finding issues on the issue trackerLeigh McCulloch
For contributors looking for new issues to contribute to it can be difficult to find issues that need a fix and don't already have a fix being considered. There are several labels that help guide the way already, like `NeedsFix`, `HelpWanted`. But many issues with this label will already have a CL. For new contributors this can be especially difficult. Fixes #26494 Change-Id: Ifd38ea65e362b4c580207a06f959646e49ac594f GitHub-Last-Rev: 6d2b54447b2ee754a6d025f5de3ebd8326e035eb GitHub-Pull-Request: golang/go#26516 Reviewed-on: https://go-review.googlesource.com/125355 Reviewed-by: Andrew Bonventre <andybons@golang.org> Run-TryBot: Andrew Bonventre <andybons@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
2018-07-31doc: fix link in contribute.htmlMohit kumar Bajoria
Fixes #26611 Change-Id: I111152c7b1156a461c9ddeaf16d2fe7a2d5a00c1 GitHub-Last-Rev: 72090d539b5601b8c585628a11a99b03103d5a75 GitHub-Pull-Request: golang/go#26724 Reviewed-on: https://go-review.googlesource.com/126935 Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-06-24doc/contribute: fix typo and reword a few sentencesAlberto Donizetti
This change fixes a typo in doc/contribute.html (afects -> affects) and rewords a few slightly akward sentences. Change-Id: I6bfbacba0de29464fce134b0fdaf3898a97b8d57 Reviewed-on: https://go-review.googlesource.com/120105 Reviewed-by: Rob Pike <r@golang.org>
2018-06-20doc: fix spelling of G SuiteStephen Lewis
'G Suite' seems to be the preferred spelling according to https://gsuite.google.com/ Change-Id: Ica60938cf942594157bba84ef205e1cdcb8c1b08 Reviewed-on: https://go-review.googlesource.com/120132 Reviewed-by: Daniel Martí <mvdan@mvdan.cc>
2018-06-20doc: change git clone urlWayne Ashley Berry
The git clone url should be a Gerrit host and not Github, otherwise the codereview command will fail. git-codereview: failed to load Gerrit origin: git origin must be a Gerrit host, not GitHub: https://github.com/golang/go Change-Id: I62f62c86ee6dce0720a844fc56340135dfae8405 Reviewed-on: https://go-review.googlesource.com/117178 Reviewed-by: Daniel Martí <mvdan@mvdan.cc> Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-06-13doc: use HTTPS for linksSuriyaa Sundararuban
Change-Id: I9d2d25df067ca573589db5ff18296a5ec33866be Reviewed-on: https://go-review.googlesource.com/118595 Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-06-13doc/contribute.html: add whitespace after <code> blocks, where missingDave Russell
Change-Id: Iea5c705dd58f9b83fbeb0500defcc08c34716169 GitHub-Last-Rev: 35702c784e2329fe3e44947430d246f8cdb04645 GitHub-Pull-Request: golang/go#25858 Reviewed-on: https://go-review.googlesource.com/118536 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-05-16doc/contribute.html: remove superfluous articleTobias Klauser
After CL 113016 the "a" article is no longer necessary. Change-Id: I5a80a210bd2b9eedd73d5f9f3f338d7f22c29ea6 Reviewed-on: https://go-review.googlesource.com/113355 Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-05-15doc/contribute.html: English cleanupsRob Pike
Fixes #24487 Change-Id: Ic523e469f7f67f376edd2fca6e07d35bb11b2db9 Reviewed-on: https://go-review.googlesource.com/113016 Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-05-14doc/contribute.html: clean up HTML and formattingRob Pike
Mostly just formatting and minor cleanup: - regularize HTML (add </p> etc.) - remove all errors caught by tidy - start all sentences on new line for easy editing Some wording changes, but there will be more to come. It seemed there were already enough edits to send it out. Update #24487 Change-Id: I613ce206b1e8e3e522ecb0bbcd2acb11c4ff5bae Reviewed-on: https://go-review.googlesource.com/113015 Reviewed-by: Ian Lance Taylor <iant@golang.org>
2018-04-16doc/contribute.html: adjust wording from previous CLRob Pike
The previous CL, 107197, overclarified the need for short subject lines. Tweak the wording to be a guideline (keep it short) rather than a limit (76 characters), which is more the Go way. Also be strict about avoiding markup language. Change-Id: I0da1132db8d86052647d96f1caac60289f2209ce Reviewed-on: https://go-review.googlesource.com/107378 Reviewed-by: Mohit Bajoria <mohitbajo36@gmail.com> Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-04-16doc: improve commit messagesmbj36
Fixes #24852 Change-Id: I71d0d7f75108bf4ad606733a45bb71baa66a4e91 Reviewed-on: https://go-review.googlesource.com/107197 Reviewed-by: Alberto Donizetti <alb.donizetti@gmail.com> Reviewed-by: Giovanni Bajo <rasky@develer.com>
2018-03-22doc: first version of new contribute guideGiovanni Bajo
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-01-29doc: fix the closing tag in contribute.htmlMohit Agarwal
Change-Id: I802bc11d90d414e7313dd11842a04fd6b591ea06 Reviewed-on: https://go-review.googlesource.com/90595 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2018-01-01doc: 2018 is the Year of the GopherBrad Fitzpatrick
Change-Id: Ie167512e000f3a8be0ff8a6a9edd52bd74f45115 Reviewed-on: https://go-review.googlesource.com/85775 Reviewed-by: Emmanuel Odeke <emm.odeke@gmail.com>
2017-12-06doc: fix two spelling mistakes in contribute.htmlAlberto Donizetti
Change-Id: Ife60468d508f90321733ebdbdb0e6cf443ba1659 Reviewed-on: https://go-review.googlesource.com/82156 Reviewed-by: Ian Lance Taylor <iant@golang.org>
2017-11-29doc: move single change workflow note in contribution guideLeigh McCulloch
The note about the single change workflow is included in the git-codereview installation instructions, but it has nothing to do with installing git-codereview. This note is more relevant for when a change is actually being made. Change-Id: Iccb90f3b7da87fab863fa4808438cd69a21a2fce Reviewed-on: https://go-review.googlesource.com/76317 Reviewed-by: Steve Francia <spf@golang.org>
2017-11-13doc: mention the scratch repoKevin Burke
If people are interested in contributing to Go, but not sure what change they'd like to make just yet, we can point them to the scratch repo, so they can go through the process of submitting and merging something now, and make more useful contributions later. My evidence that sending people to the scratch repo would encourage future contributions is that a number of people who went through the workshop at Gophercon have continued to send CL's after submitting to the scratch repo, even though I doubt they planned to before going through the workshop. Change-Id: Ieb48415773c0ee7dc400f8bf6f57f752eca8eeb5 Reviewed-on: https://go-review.googlesource.com/49970 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-10-04doc: update contribute.html to clarify replying to reviews via emailAndrew Bonventre
Update golang/go#22120 Change-Id: Ie7dbd0e7b01b116c960243a8cd3fa9fd121f317d Reviewed-on: https://go-review.googlesource.com/68021 Reviewed-by: Ian Lance Taylor <iant@golang.org> Reviewed-by: Dave Cheney <dave@cheney.net>
2017-08-09doc/contribute: improve wording of Gerrit descriptionChristian Alexander
The word "of" was removed in https://go-review.googlesource.com/c/36626 Change-Id: Iece69f425d06ab1cf02743b1033cfed2e96667ab Reviewed-on: https://go-review.googlesource.com/54290 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-08-09doc/contribute.html: fix name of .gitcookies fileRaviTeja
Change-Id: I41c22b9c6933b3f3469c0e815048a49e1d37927a Reviewed-on: https://go-review.googlesource.com/54190 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-07-14doc/contribute: avoid using the word "change list".Han-Wen Nienhuys
Neither the Gerrit UI nor its docs use the term CL or changelist. Change-Id: Ic19fddc660ec4f008f10fd207e4ac6349431ff5d Reviewed-on: https://go-review.googlesource.com/48595 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-06-14doc: add go-contrib-init mention to contributing docsBrad Fitzpatrick
Fixes #17802 Change-Id: I245552534c3e21d95c569ac7118ba289244ba11d Reviewed-on: https://go-review.googlesource.com/45652 Reviewed-by: Steve Francia <spf@golang.org>
2017-05-04doc: fix minor formatting issues in contribute.htmlAdam Bender
- remove <code> from <pre> - replace `` with <code></code> Change-Id: I46f0aec8b7645e2ac8cb53bca73aed55441acd65 Reviewed-on: https://go-review.googlesource.com/42612 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-05-02doc/contribute: directly link to the Agreements pageAlberto Donizetti
There's no Settings->Agreement path for PolyGerrit users, but if we link directly to the page in the instructions, Gerrit will inform them that they can access the page by switching to the old UI. Fixes #20207 Change-Id: I0887ee854e4ac5975b5f305adb6259b81b41618f Reviewed-on: https://go-review.googlesource.com/42412 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-03-16doc: reorganize the contribution guidelines into a guideSteve Francia
Updates #17802 Change-Id: I65ea0f4cde973604c04051e7eb25d12e4facecd3 Reviewed-on: https://go-review.googlesource.com/36626 Reviewed-by: Ian Lance Taylor <iant@golang.org> Reviewed-by: Chris Broadfoot <cbro@golang.org>
2017-02-08doc: remove the confusing use of CLJaana Burcu Dogan
CL (change list) pops out of nowhere and confuses the reader. Use "change" instead to be consistent with the rest of the document. Fixes #18989. Change-Id: I525a63a195dc6bb992c8ad0f10c2f2e1b2b952df Reviewed-on: https://go-review.googlesource.com/36564 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-01-16doc: 2017 is the Year of the GopherBrad Fitzpatrick
Change-Id: Iac713ae1f322f893c92b3fc47fe9b5719052f9eb Reviewed-on: https://go-review.googlesource.com/35240 Reviewed-by: Ian Lance Taylor <iant@golang.org> Reviewed-by: David Symonds <dsymonds@golang.org> Reviewed-by: Minux Ma <minux@golang.org>
2016-05-24doc: add notes on good commit messagesJeff R. Allen
Explain Brad's algorithm for generating commit headlines. Fixes #15700 Change-Id: Ic602f17629b3dd7675e2bb1ed119062c03353ee9 Reviewed-on: https://go-review.googlesource.com/23355 Reviewed-by: Ian Lance Taylor <iant@golang.org> Run-TryBot: Ian Lance Taylor <iant@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
2016-04-23doc: mention security from contribution guidelinesFrancesc Campoy
Fixes #15413 Change-Id: I837a391276eed565cf66d3715ec68b7b959ce143 Reviewed-on: https://go-review.googlesource.com/22390 Reviewed-by: Andrew Gerrand <adg@golang.org>
2016-03-09doc: fix bogus HTML in contribute.htmlBrad Fitzpatrick
Introduced in https://golang.org/cl/20462 Change-Id: I6c55f87228f0980058a10f204b57ead7594e3492 Reviewed-on: https://go-review.googlesource.com/20490 Reviewed-by: Andrew Gerrand <adg@golang.org>
generated by cgit v1.3 (git 2.53.0) at 2026-04-16 07:51:21 +0000