diff --git a/ExperienceReports.md b/ExperienceReports.md index 529fd5ba..1973995e 100644 --- a/ExperienceReports.md +++ b/ExperienceReports.md @@ -6,7 +6,7 @@ This page collects experience reports about problems with Go that might inform o We hope to use these experience reports to understand where people are having trouble writing Go, to help us prioritize future changes to the Go ecosystem. (We do not promise to reply to these. If you need immediate help answering questions about Go, see [https://go.dev/help/](https://go.dev/help/) for resources.) -__The best experience reports tell: (1) what you wanted to do, (2) what you actually did, and (3) why that wasn’t great, illustrating those by real concrete examples, ideally from production use.__ Please write these reports about the problems most significant to you, post them on your own blog, or on Medium, or as a [Github Gist](https://gist.github.com/) (use a `.md` extension for Markdown), or as a publicly-readable Google doc, and then link them here. (Talk videos or slides are also welcome, although they are not as convenient for us to digest.) +__The best experience reports tell: (1) what you wanted to do, (2) what you actually did, and (3) why that wasn’t great, illustrating those by real concrete examples, ideally from production use.__ Please write these reports about the problems most significant to you, post them on your own blog, or on Medium, or as a [GitHub Gist](https://gist.github.com/) (use a `.md` extension for Markdown), or as a publicly-readable Google doc, and then link them here. (Talk videos or slides are also welcome, although they are not as convenient for us to digest.) If you do not have permission to edit the wiki to add an article to this list, [please file an issue](https://go.dev/issue/new). @@ -201,9 +201,9 @@ a complex solution for the problem. ## Modules - Paul Jolly - "[Creating a submodule within an existing module](https://gist.github.com/myitcv/79c3f12372e13b0cbbdf0411c8c46fd5)" - covers multi-module repos, cyclic module dependencies and the steps required to move between various "states" - - Chi authors - [Github comment](https://github.com/go-chi/chi/pull/378#issuecomment-453274681) - comment on why the Chi authors held out on implementing Go Modules support (which has been added in the meantime). TL;DR ­— due to the import compatibility rule. + - Chi authors - [GitHub comment](https://github.com/go-chi/chi/pull/378#issuecomment-453274681) - comment on why the Chi authors held out on implementing Go Modules support (which has been added in the meantime). TL;DR ­— due to the import compatibility rule. - Sam Whited -"[Supporting Go Modules](https://blog.samwhited.com/2019/01/supporting-go-modules/)" - Things learned from upgrading 20 so modules. TL;DR — upgrading large modules past v1 is a huge pain and needs tooling, failure modes for modules are very complex and it's easy to screw up adding modules support to existing projects. - - Stripe Github thread (linked comment down) - [reverting support for Go Modules](https://github.com/stripe/stripe-go/pull/712#issuecomment-454594534). TL;DR — Stripe is reverting Go Modules support because there is no clear upgrade path from dep for modules above v1. + - Stripe GitHub thread (linked comment down) - [reverting support for Go Modules](https://github.com/stripe/stripe-go/pull/712#issuecomment-454594534). TL;DR — Stripe is reverting Go Modules support because there is no clear upgrade path from dep for modules above v1. - [Referencing bash scripts in `GOPATH`](https://gist.github.com/ineiti/4a4a1798876225f7a553a13120d705ae) - [Go Modules on Badger and Dgraph](https://discuss.dgraph.io/t/go-modules-on-badger-and-dgraph/4662). TL;DR - Dgraph is dropping support for v2 because it forces non-Go modules users to change their code. - [A survey on Golang's dependency management modes (GOPATH and Go Modules): status quo, problems and challenges](https://github.com/KateGo520/Hero/issues/1). - The purpose of this report is to help developers better understand the issues in the transition from GOPATH to Go Modules. diff --git a/Gardening.md b/Gardening.md index 1bbd31f9..250bdc03 100644 --- a/Gardening.md +++ b/Gardening.md @@ -10,9 +10,9 @@ This page lists common Go gardening tasks. ## Access -If you've been regularly active in the Go community for some time, feel free to ask for Gerrit and/or Github access to modify things. +If you've been regularly active in the Go community for some time, feel free to ask for Gerrit and/or GitHub access to modify things. -See https://go.dev/wiki/GerritAccess and https://go.dev/wiki/GithubAccess +See https://go.dev/wiki/GerritAccess and https://go.dev/wiki/GitHubAccess ## Gardening Tasks diff --git a/GerritAccess.md b/GerritAccess.md index ef0bcb12..234695cb 100644 --- a/GerritAccess.md +++ b/GerritAccess.md @@ -4,7 +4,7 @@ title: Gerrit Access There are two types of Gerrit access described here, with different powers & responsibilities. Only ask for access if you're an active member of the community. New contributors should participate in the Gerrit code review process for some time before requesting access. -(For Github access, see https://go.dev/wiki/GithubAccess) +(For GitHub access, see https://go.dev/wiki/GitHubAccess) ## Running TryBots ("may-start-trybots") diff --git a/GerritBot.md b/GerritBot.md index 3c6f3d3b..09c72507 100644 --- a/GerritBot.md +++ b/GerritBot.md @@ -38,7 +38,7 @@ Replies to comments on code in Gerrit are first saved as drafts and need to be p It uses the title and description of the GitHub PR to construct the commit message for the Gerrit change. You can edit this using the GitHub web interface (not Gerrit or git). The PR description is in the first text area in the "Conversation" tab of the GitHub PR. It is editable via "Edit" option on the "..." menu. -**Note:** Gerrit imports the **plain** text that is viewable as you edit the message in Github, and it does not import the **rendered** text you see in GitHub prior to editing. +**Note:** Gerrit imports the **plain** text that is viewable as you edit the message in GitHub, and it does not import the **rendered** text you see in GitHub prior to editing. One common area of related confusion is around **issue references**. For example, GerritBot or a human reviewer might ask you to [avoid URLs for issue references](https://go.dev/doc/contribute#ref_issues). In Gerrit, you might see the full URL for an issue, but in the GitHub web interface, you might only see an issue reference like `#12345` and it might be unclear where the URL is coming from. This can be due to confusion between the rendered view in GitHub vs. the underlying raw/plain text. If the GitHub web interface shows something like `Fixes https://github.com/golang/go/issues/12345` while you are **editing the text in GitHub**, change it to something like `Fixes #12345` or `Fixes golang/go#12345` instead. See the [Contribution Guide](https://go.dev/doc/contribute#ref_issues) for more on issue references. diff --git a/GithubAccess.md b/GitHubAccess.md similarity index 76% rename from GithubAccess.md rename to GitHubAccess.md index b7a9a575..064d8092 100644 --- a/GithubAccess.md +++ b/GitHubAccess.md @@ -1,8 +1,8 @@ --- -title: GithubAccess +title: GitHubAccess --- -There are two types of Github access described here, with different powers & responsibilities. Only ask for access if you're an active member of the community. New contributors should participate in the Github & Gerrit review process for some time before requesting access. +There are two types of GitHub access described here, with different powers & responsibilities. Only ask for access if you're an active member of the community. New contributors should participate in the GitHub & Gerrit review process for some time before requesting access. (For Gerrit access, see https://go.dev/wiki/GerritAccess) @@ -10,19 +10,19 @@ There are two types of Github access described here, with different powers & res The "go-assignees" group is a read-only group granting no special access, other than it allows the users in the group to be assigned issues. -In general, Go doesn't use the "Assigned to" field of bugs much. Instead, we just leave a comment saying we'll work on it. But if you want this access, reference https://github.com/orgs/golang/teams/go-assignees and your Github username in your issue requesting access. +In general, Go doesn't use the "Assigned to" field of bugs much. Instead, we just leave a comment saying we'll work on it. But if you want this access, reference https://github.com/orgs/golang/teams/go-assignees and your GitHub username in your issue requesting access. ## Editors The "go-editors" group is the set of people who can edit metadata on issues. -To request this type of access, reference https://github.com/orgs/golang/teams/go-editors and your Github username in your issue requesting access. +To request this type of access, reference https://github.com/orgs/golang/teams/go-editors and your GitHub username in your issue requesting access. Please do not edit any field you're not confident about. Feel free to ask for second opinions. ## Requesting Access -To request any of the access types above, file a new issue (https://go.dev/issue/new?title=access:+&body=See+https://go.dev/wiki/GithubAccess.) and state which access you want (its name and group URL). +To request any of the access types above, file a new issue (https://go.dev/issue/new?title=access:+&body=See+https://go.dev/wiki/GitHubAccess.) and state which access you want (its name and group URL). ## Once you have access diff --git a/GoGetTools.md b/GoGetTools.md index 327c892e..a3aab62b 100644 --- a/GoGetTools.md +++ b/GoGetTools.md @@ -11,6 +11,6 @@ The ` go get ` fetching of source code is done by using one of the following too * **git** - Git, download at http://git-scm.com/downloads * **bzr** - Bazaar, download at http://wiki.bazaar.canonical.com/Download -For example, **git** is used for Github, **hg** is used for Bitbucket, etc. +For example, **git** is used for GitHub, **hg** is used for Bitbucket, etc. Refer [GoGetProxyConfig](GoGetProxyConfig) for setting proxies for these tools. diff --git a/GoUsers.md b/GoUsers.md index 8254b285..5be8fe98 100644 --- a/GoUsers.md +++ b/GoUsers.md @@ -275,7 +275,7 @@ title: GoUsers * [League](https://league.com) - [jobs](https://league.com/careers-at-league/) * [Lendesk](https://lendesk.com) - [jobs](https://lendesk.com/careers) * [Lightspeed](https://www.lightspeedhq.com/) - [jobs](https://www.lightspeedhq.com/careers/openings/?office=canada&department=technology) - * [LoginRadius](https://www.loginradius.com/) - [Blog](https://www.loginradius.com/engineering/blog/) - [Github](https://github.com/LoginRadius) + * [LoginRadius](https://www.loginradius.com/) - [Blog](https://www.loginradius.com/engineering/blog/) - [GitHub](https://github.com/LoginRadius) * [Manifold](https://manifold.co) * [NV Digital](https://www.nvdigital.co/) * [Obkio](https://obkio.com/) @@ -670,7 +670,7 @@ title: GoUsers * [Parsaspace](https://parsaspace.com) - Parsaspace is an iranian storage as a service * [Shafa.clinic](https://Shafa.clinic/) - best medical laser service in Iran * [Cafe Bazaar](https://cafebazaar.ir/?l=en/) - Iranian Android marketplace - * [Alibaba Travels Co.](https://alibaba.ir/) - [(Github)](https://github.com/alibaba-go) - Iranian online travel agency + * [Alibaba Travels Co.](https://alibaba.ir/) - [(GitHub)](https://github.com/alibaba-go) - Iranian online travel agency ### Ireland * [EXADS](http://exads.com/) @@ -1466,7 +1466,7 @@ Certificate Expiry Monitor Controller monitors the expiration of TLS certificate * [Aruba Networks](http://www.arubanetworks.com/) - [golang-nuts](https://groups.google.com/d/msg/golang-nuts/M2koiSyoF6E/8rUujT5RCwEJ) * [Ascendant Compliance Manager](https://www.ascendantcompliancemanager.com/) - Batch process millions of security trades per day. * [Assembled](https://www.assembled.com/) - [github](https://github.com/assembledhq) - * [AT&T](https://www.att.com/) - [Github](https://github.com/att?utf8=%E2%9C%93&q=&type=&language=go) and [gopkgs repository](https://github.com/att/gopkgs) + * [AT&T](https://www.att.com/) - [GitHub](https://github.com/att?utf8=%E2%9C%93&q=&type=&language=go) and [gopkgs repository](https://github.com/att/gopkgs) * [Atatus](http://www.atatus.com/) - [blog](http://www.atatus.com/blog/golang-auto-build-versioning/) * [Aura](https://aura.com) * [Avocet](http://avocet.io/) - [blog](http://blog.avocet.io/from-0-to-6-2-billion-requests/) @@ -1597,7 +1597,7 @@ Certificate Expiry Monitor Controller monitors the expiration of TLS certificate * [HashiCorp](https://hashicorp.com/) - [github](https://github.com/hashicorp) * [HER](https://weareher.com/) * [Heroku](http://heroku.com/) - [Go blog post](https://go.dev/blog/2011/04/go-at-heroku.html), [news](http://www.theregister.co.uk/2011/05/05/google_go/) - * [Hewlett Packard Enterprise](https://hpe.com) - [Github](https://github.com/HewlettPackard) + * [Hewlett Packard Enterprise](https://hpe.com) - [GitHub](https://github.com/HewlettPackard) * [Home24](http://www.home24.de) - [github](https://github.com/home24) * [Honeywell](https://www.honeywell.com) * [Hooklift](https://github.com/hooklift) - [github](https://github.com/hooklift) @@ -1693,7 +1693,7 @@ Certificate Expiry Monitor Controller monitors the expiration of TLS certificate * [Nutanix](http://www.nutanix.com) * [Odoscope](http://www.odoscope.com) - [twitter](https://twitter.com/odoscope/status/642383738249322496), [job](http://www.odoscope.com/career-at-odoscope/developer-vacancy/) * [Ookma-Kyi](https://www.ookma-kyi.tech) - Open Source Implementation of the now defunct Battlemail MMO -[Github](https://www.github.com/ookma-kyi/) [Twitter](https://mobile.twitter.com/Ookma_Kyi/) +[GitHub](https://www.github.com/ookma-kyi/) [Twitter](https://mobile.twitter.com/Ookma_Kyi/) * [Ooyala](http://www.ooyala.com/) - [github](https://github.com/ooyala/) * [Opendoor](https://www.opendoor.com/) - [HN](https://news.ycombinator.com/item?id=10657348) * [OpenShift](https://www.openshift.com/) - [blog](http://blog.gopheracademy.com/birthday-bash-2014/openshift-3-old-dogs-new-tricks/)