forked from Mirrors/oauth2
doc: add CONTRIBUTING.md
Change-Id: I6cb60270a3de13fd5b8e06ae9ecffc08d6b6d8d5 Reviewed-on: https://go-review.googlesource.com/5222 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
This commit is contained in:
parent
35468a7526
commit
36fb42e1e8
|
@ -1,25 +1,31 @@
|
||||||
# Contributing
|
# Contributing to Go
|
||||||
|
|
||||||
We don't use GitHub pull requests but use Gerrit for code reviews,
|
Go is an open source project.
|
||||||
similar to the Go project.
|
|
||||||
|
|
||||||
1. Sign one of the contributor license agreements below.
|
It is the work of hundreds of contributors. We appreciate your help!
|
||||||
2. `go get golang.org/x/review/git-codereview` to install the code reviewing tool.
|
|
||||||
3. Get the package by running `go get -d golang.org/x/oauth2`.
|
|
||||||
Make changes and create a change by running `git codereview change <name>`, provide a command message, and use `git codereview mail` to create a Gerrit CL.
|
|
||||||
Keep amending to the change and mail as your recieve feedback.
|
|
||||||
|
|
||||||
For more information about the workflow, see Go's [Contribution Guidelines](https://golang.org/doc/contribute.html).
|
|
||||||
|
|
||||||
Before we can accept any pull requests
|
## Filing issues
|
||||||
we have to jump through a couple of legal hurdles,
|
|
||||||
primarily a Contributor License Agreement (CLA):
|
|
||||||
|
|
||||||
- **If you are an individual writing original source code**
|
When [filing an issue](https://golang.org/issue/new), make sure to answer these five questions:
|
||||||
and you're sure you own the intellectual property,
|
|
||||||
then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html).
|
1. What version of Go are you using (`go version`)?
|
||||||
- **If you work for a company that wants to allow you to contribute your work**,
|
2. What operating system and processor architecture are you using?
|
||||||
then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html).
|
3. What did you do?
|
||||||
|
4. What did you expect to see?
|
||||||
|
5. What did you see instead?
|
||||||
|
|
||||||
|
General questions should go to the [golang-nuts mailing list](https://groups.google.com/group/golang-nuts) instead of the issue tracker.
|
||||||
|
The gophers there will answer or ask you to file an issue if you've tripped over a bug.
|
||||||
|
|
||||||
|
## Contributing code
|
||||||
|
|
||||||
|
Please read the [Contribution Guidelines](https://golang.org/doc/contribute.html)
|
||||||
|
before sending patches.
|
||||||
|
|
||||||
|
**We do not accept GitHub pull requests**
|
||||||
|
(we use [Gerrit](https://code.google.com/p/gerrit/) instead for code review).
|
||||||
|
|
||||||
|
Unless otherwise noted, the Go source files are distributed under
|
||||||
|
the BSD-style license found in the LICENSE file.
|
||||||
|
|
||||||
You can sign these electronically (just scroll to the bottom).
|
|
||||||
After that, we'll be able to accept your pull requests.
|
|
||||||
|
|
Loading…
Reference in New Issue