qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-25 10:57:58 -07:00
Code Releases Activity
fe20b73606
go/CONTRIBUTING.md

36 lines
1.3 KiB
Markdown
Raw Normal View History

doc: convert README to markdown and update CONTRIBUTING.md Fixes #9233 Change-Id: If64480cbfaafe44025fcdcc0f20d76c995ffb3a1 Reviewed-on: https://go-review.googlesource.com/1296 Reviewed-by: Russ Cox <rsc@golang.org>
2014-12-09 22:06:47 -07:00
# Contributing to Go
doc: add CONRIBUTORS.md This file is known to GitHub and will be linked prominently when potential contributors try to open pull requests. Here's how it should appear: https://gist.github.com/adg/e0ffcc922a32f20af3db Change-Id: I41c5aadf284a0a24c485f96b7fe2caa338ad1e4f Reviewed-on: https://go-review.googlesource.com/1178 Reviewed-by: Rob Pike <r@golang.org>
2014-12-08 04:05:57 -07:00
doc: convert README to markdown and update CONTRIBUTING.md Fixes #9233 Change-Id: If64480cbfaafe44025fcdcc0f20d76c995ffb3a1 Reviewed-on: https://go-review.googlesource.com/1296 Reviewed-by: Russ Cox <rsc@golang.org>
2014-12-09 22:06:47 -07:00
Go is an open source project.
doc: add CONRIBUTORS.md This file is known to GitHub and will be linked prominently when potential contributors try to open pull requests. Here's how it should appear: https://gist.github.com/adg/e0ffcc922a32f20af3db Change-Id: I41c5aadf284a0a24c485f96b7fe2caa338ad1e4f Reviewed-on: https://go-review.googlesource.com/1178 Reviewed-by: Rob Pike <r@golang.org>
2014-12-08 04:05:57 -07:00
doc: convert README to markdown and update CONTRIBUTING.md Fixes #9233 Change-Id: If64480cbfaafe44025fcdcc0f20d76c995ffb3a1 Reviewed-on: https://go-review.googlesource.com/1296 Reviewed-by: Russ Cox <rsc@golang.org>
2014-12-09 22:06:47 -07:00
It is the work of hundreds of contributors. We appreciate your help!
doc: add CONRIBUTORS.md This file is known to GitHub and will be linked prominently when potential contributors try to open pull requests. Here's how it should appear: https://gist.github.com/adg/e0ffcc922a32f20af3db Change-Id: I41c5aadf284a0a24c485f96b7fe2caa338ad1e4f Reviewed-on: https://go-review.googlesource.com/1178 Reviewed-by: Rob Pike <r@golang.org>
2014-12-08 04:05:57 -07:00
doc: improve issue template and contribution guidelines Encourage people towards the various help forums as a first port of call. Better sign-posting will reduce the incidence or questions being asked in the issue tracker that should otherwise be handled elsewhere, thereby keeping the issue tracker email traffic more focussed. Change-Id: I13b2e498d88be010fca421067ae6fb579a46d6b7 Reviewed-on: https://go-review.googlesource.com/34250 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2016-12-09 04:15:23 -07:00
## Before filing an issue
If you are unsure whether you have found a bug, please consider asking in the [golang-nuts mailing
list](https://groups.google.com/forum/#!forum/golang-nuts) or [other forums](https://golang.org/help/) first. If
the behavior you are seeing is confirmed as a bug or issue, it can easily be re-raised in the issue tracker.
doc: add CONRIBUTORS.md This file is known to GitHub and will be linked prominently when potential contributors try to open pull requests. Here's how it should appear: https://gist.github.com/adg/e0ffcc922a32f20af3db Change-Id: I41c5aadf284a0a24c485f96b7fe2caa338ad1e4f Reviewed-on: https://go-review.googlesource.com/1178 Reviewed-by: Rob Pike <r@golang.org>
2014-12-08 04:05:57 -07:00
doc: convert README to markdown and update CONTRIBUTING.md Fixes #9233 Change-Id: If64480cbfaafe44025fcdcc0f20d76c995ffb3a1 Reviewed-on: https://go-review.googlesource.com/1296 Reviewed-by: Russ Cox <rsc@golang.org>
2014-12-09 22:06:47 -07:00
## Filing issues
doc: add CONRIBUTORS.md This file is known to GitHub and will be linked prominently when potential contributors try to open pull requests. Here's how it should appear: https://gist.github.com/adg/e0ffcc922a32f20af3db Change-Id: I41c5aadf284a0a24c485f96b7fe2caa338ad1e4f Reviewed-on: https://go-review.googlesource.com/1178 Reviewed-by: Rob Pike <r@golang.org>
2014-12-08 04:05:57 -07:00
doc: improve issue template and contribution guidelines Encourage people towards the various help forums as a first port of call. Better sign-posting will reduce the incidence or questions being asked in the issue tracker that should otherwise be handled elsewhere, thereby keeping the issue tracker email traffic more focussed. Change-Id: I13b2e498d88be010fca421067ae6fb579a46d6b7 Reviewed-on: https://go-review.googlesource.com/34250 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2016-12-09 04:15:23 -07:00
Sensitive security-related issues should be reported to [security@golang.org](mailto:security@golang.org).
See the [security policy](https://golang.org/security) for details.
doc: update CONTRIBUTING.md a bit, mention proposal process Fixes #18550 Change-Id: Ia08d0ef6964216fcc14fa63c2ba378d68daa2c02 Reviewed-on: https://go-review.googlesource.com/34917 Reviewed-by: Chris Broadfoot <cbro@golang.org>
2017-01-06 15:45:17 -07:00
.github: recommend 'go bug' when filing an issue It was released with 1.8, so it should be widely available. Change-Id: I7dcf205009b528071ea63f99cb5da0db183df341 Reviewed-on: https://go-review.googlesource.com/50932 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2017-07-24 10:54:13 -06:00
The recommended way to file an issue is by running `go bug`.
doc: improve issue template and contribution guidelines Encourage people towards the various help forums as a first port of call. Better sign-posting will reduce the incidence or questions being asked in the issue tracker that should otherwise be handled elsewhere, thereby keeping the issue tracker email traffic more focussed. Change-Id: I13b2e498d88be010fca421067ae6fb579a46d6b7 Reviewed-on: https://go-review.googlesource.com/34250 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2016-12-09 04:15:23 -07:00
Otherwise, when filing an issue, make sure to answer these five questions:
doc: convert README to markdown and update CONTRIBUTING.md Fixes #9233 Change-Id: If64480cbfaafe44025fcdcc0f20d76c995ffb3a1 Reviewed-on: https://go-review.googlesource.com/1296 Reviewed-by: Russ Cox <rsc@golang.org>
2014-12-09 22:06:47 -07:00
1. What version of Go are you using (`go version`)?
2. What operating system and processor architecture are you using?
3. What did you do?
4. What did you expect to see?
5. What did you see instead?
doc: normalize proposal-process links The docs in .github & CONTRIBUTING.md have three different links to the same place. I have picked the one from "10-proposal.md" as the canonical url as it uses the normal go website shortener service (thus centralizing any future maintenance of this location), uses the new public domain (go.dev over golang.org), and also picks up the readme URI fragment from the shortener redirect which allows the doc links to be cleaner, but also the convenience for the reader starting directly at the human readable parsed README.md. Should also cut down on confusion like I had reading documentation about why there were multiple proposal sites, which turned out all to be the same place. Update all proposal-process links to the same URL. Change-Id: I2f2ea3a6ca34a445268285520e1b19570946afb8 GitHub-Last-Rev: eb769089e612e6c00c29baf3c6cd2e0875e46364 GitHub-Pull-Request: golang/go#59238 Reviewed-on: https://go-review.googlesource.com/c/go/+/479415 Reviewed-by: Ian Lance Taylor <iant@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Matthew Dempsky <mdempsky@google.com> Run-TryBot: Ian Lance Taylor <iant@google.com> Auto-Submit: Ian Lance Taylor <iant@google.com>
2023-03-25 09:53:55 -06:00
For change proposals, see [Proposing Changes To Go](https://go.dev/s/proposal-process).
doc: convert README to markdown and update CONTRIBUTING.md Fixes #9233 Change-Id: If64480cbfaafe44025fcdcc0f20d76c995ffb3a1 Reviewed-on: https://go-review.googlesource.com/1296 Reviewed-by: Russ Cox <rsc@golang.org>
2014-12-09 22:06:47 -07:00
## Contributing code
doc: improve issue template and contribution guidelines Encourage people towards the various help forums as a first port of call. Better sign-posting will reduce the incidence or questions being asked in the issue tracker that should otherwise be handled elsewhere, thereby keeping the issue tracker email traffic more focussed. Change-Id: I13b2e498d88be010fca421067ae6fb579a46d6b7 Reviewed-on: https://go-review.googlesource.com/34250 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
2016-12-09 04:15:23 -07:00
Please read the [Contribution Guidelines](https://golang.org/doc/contribute.html) before sending patches.
doc: convert README to markdown and update CONTRIBUTING.md Fixes #9233 Change-Id: If64480cbfaafe44025fcdcc0f20d76c995ffb3a1 Reviewed-on: https://go-review.googlesource.com/1296 Reviewed-by: Russ Cox <rsc@golang.org>
2014-12-09 22:06:47 -07:00
doc: update README.md and CONTRIBUTING.md in response to review comments I didn't 'add' these files before my final mail. Change-Id: Id6f25629638e58421a3dee7632aec38aad9b1970 Reviewed-on: https://go-review.googlesource.com/1340 Reviewed-by: Andrew Gerrand <adg@golang.org>
2014-12-10 15:44:54 -07:00
Unless otherwise noted, the Go source files are distributed under
doc: convert README to markdown and update CONTRIBUTING.md Fixes #9233 Change-Id: If64480cbfaafe44025fcdcc0f20d76c995ffb3a1 Reviewed-on: https://go-review.googlesource.com/1296 Reviewed-by: Russ Cox <rsc@golang.org>
2014-12-09 22:06:47 -07:00
the BSD-style license found in the LICENSE file.
doc: add CONRIBUTORS.md This file is known to GitHub and will be linked prominently when potential contributors try to open pull requests. Here's how it should appear: https://gist.github.com/adg/e0ffcc922a32f20af3db Change-Id: I41c5aadf284a0a24c485f96b7fe2caa338ad1e4f Reviewed-on: https://go-review.googlesource.com/1178 Reviewed-by: Rob Pike <r@golang.org>
2014-12-08 04:05:57 -07:00
Copy Permalink