appengine/v2/CONTRIBUTING.md

89 строки
3.4 KiB
Markdown
Исходник Постоянная ссылка Обычный вид История

Merge QA into the main branch (#247) * Removing old, unsupported APIs (#230) * Remove the old Search API. * Remove the old Remote API. * Remove the old sockets API. * Delete legacy appengine code (#231) - Delete all files behind `+build appengine` - Merge the `*_vm.go` variants with the base files - `go fix` for context update (TODO: Fix internal/api.go's use of context) - Update travis config to test new versions * Remove Query APIs from appengine.log (#233) Remove deprecated log.Query api from appengine.log * Update docs (#234) * Remove the old Search API. * Remove the old Remote API. * Remove the old sockets API. * Temporarily remove blobstore API for v2 preview. * Revert "Temporarily remove blobstore API for v2 preview." This reverts commit 169bbdd4674a0fc862fd6a12a843eb2b3bba01cd. * Update docs for QA. * Update module API docs to indicate manual_scaling must be used for NumInstances, etc. * Update module API docs to indicate manual_scaling must be used for NumInstances, etc. * Remove old interfaces and interfaces that are not recommended (#236) * Remove the old deprecated channel interface. * Remove the old deprecated file interface. * Remove the old deprecated xmpp interface. * Removing the cloudsql interface, which is not recommended. * Removing the aebundler interface, which has been deprecated for some time. * Remove obsolete demo code (#238) * Remove obsolete demo code. Official appengine sample code referred by doc is in https://github.com/GoogleCloudPlatform/golang-samples * Replace Logs API with Stdout (#240) * Removed Logs API. * Remove dead code. * Added JSON encoding tests. * Emit single character severity in JSON message to trigger structured logs handling. * Prevent timestamp from being emitted on deployed logs. * Remove superfluous apis (#241) * Removed protos for channel/search/xmpp. * Remove protos for socket. * Add traceID/spanID to structured logs and chunk long logs (#242) * Moved logging related logic to separate file. * Added traceID/spanID to structured logs and log chunking. * Changes from code review. * Update go.mod for v2 * Revert v2 in the base directory. * Create the v2 in /v2 and revert the base directory back to 1.6.7 (#243) * Create a v2 directory for v2+ releases. * Update AppEngine imports to v2. * Update AppEngine imports to v2. * Clean up travis. We only currently support go 1.11+ * Temporarily disable testing go111+ with gopath until we can tag v2 properly. * Tidy v2/go.mod (#244) * Create a v2 directory for v2+ releases. * Update AppEngine imports to v2. * Update AppEngine imports to v2. * Clean up travis. We only currently support go 1.11+ * Temporarily disable testing go111+ with gopath until we can tag v2 properly. * Tidy go.sum * go mod tidy (#245) * Create a v2 directory for v2+ releases. * Update AppEngine imports to v2. * Update AppEngine imports to v2. * Clean up travis. We only currently support go 1.11+ * Temporarily disable testing go111+ with gopath until we can tag v2 properly. * Tidy go.sum * go mod tidy Co-authored-by: Steven Buss <sbuss@google.com> Co-authored-by: Kayla Nguyen <kaylanguyen@google.com> Co-authored-by: Jason Collins <jason.a.collins@gmail.com>
2021-06-15 20:57:49 +03:00
# Contributing
1. Sign one of the contributor license agreements below.
1. Get the package:
`go get -d google.golang.org/appengine`
1. Change into the checked out source:
`cd $GOPATH/src/google.golang.org/appengine`
1. Fork the repo.
1. Set your fork as a remote:
`git remote add fork git@github.com:GITHUB_USERNAME/appengine.git`
1. Make changes, commit to your fork.
1. Send a pull request with your changes.
The first line of your commit message is conventionally a one-line summary of the change, prefixed by the primary affected package, and is used as the title of your pull request.
# Testing
## Running system tests
Set the `APPENGINE_DEV_APPSERVER` environment variable to `/path/to/go_appengine/dev_appserver.py`.
Run tests with `go test`:
Merge QA into the main branch (#247) * Removing old, unsupported APIs (#230) * Remove the old Search API. * Remove the old Remote API. * Remove the old sockets API. * Delete legacy appengine code (#231) - Delete all files behind `+build appengine` - Merge the `*_vm.go` variants with the base files - `go fix` for context update (TODO: Fix internal/api.go's use of context) - Update travis config to test new versions * Remove Query APIs from appengine.log (#233) Remove deprecated log.Query api from appengine.log * Update docs (#234) * Remove the old Search API. * Remove the old Remote API. * Remove the old sockets API. * Temporarily remove blobstore API for v2 preview. * Revert "Temporarily remove blobstore API for v2 preview." This reverts commit 169bbdd4674a0fc862fd6a12a843eb2b3bba01cd. * Update docs for QA. * Update module API docs to indicate manual_scaling must be used for NumInstances, etc. * Update module API docs to indicate manual_scaling must be used for NumInstances, etc. * Remove old interfaces and interfaces that are not recommended (#236) * Remove the old deprecated channel interface. * Remove the old deprecated file interface. * Remove the old deprecated xmpp interface. * Removing the cloudsql interface, which is not recommended. * Removing the aebundler interface, which has been deprecated for some time. * Remove obsolete demo code (#238) * Remove obsolete demo code. Official appengine sample code referred by doc is in https://github.com/GoogleCloudPlatform/golang-samples * Replace Logs API with Stdout (#240) * Removed Logs API. * Remove dead code. * Added JSON encoding tests. * Emit single character severity in JSON message to trigger structured logs handling. * Prevent timestamp from being emitted on deployed logs. * Remove superfluous apis (#241) * Removed protos for channel/search/xmpp. * Remove protos for socket. * Add traceID/spanID to structured logs and chunk long logs (#242) * Moved logging related logic to separate file. * Added traceID/spanID to structured logs and log chunking. * Changes from code review. * Update go.mod for v2 * Revert v2 in the base directory. * Create the v2 in /v2 and revert the base directory back to 1.6.7 (#243) * Create a v2 directory for v2+ releases. * Update AppEngine imports to v2. * Update AppEngine imports to v2. * Clean up travis. We only currently support go 1.11+ * Temporarily disable testing go111+ with gopath until we can tag v2 properly. * Tidy v2/go.mod (#244) * Create a v2 directory for v2+ releases. * Update AppEngine imports to v2. * Update AppEngine imports to v2. * Clean up travis. We only currently support go 1.11+ * Temporarily disable testing go111+ with gopath until we can tag v2 properly. * Tidy go.sum * go mod tidy (#245) * Create a v2 directory for v2+ releases. * Update AppEngine imports to v2. * Update AppEngine imports to v2. * Clean up travis. We only currently support go 1.11+ * Temporarily disable testing go111+ with gopath until we can tag v2 properly. * Tidy go.sum * go mod tidy Co-authored-by: Steven Buss <sbuss@google.com> Co-authored-by: Kayla Nguyen <kaylanguyen@google.com> Co-authored-by: Jason Collins <jason.a.collins@gmail.com>
2021-06-15 20:57:49 +03:00
```
go test -v google.golang.org/appengine/v2/...
Merge QA into the main branch (#247) * Removing old, unsupported APIs (#230) * Remove the old Search API. * Remove the old Remote API. * Remove the old sockets API. * Delete legacy appengine code (#231) - Delete all files behind `+build appengine` - Merge the `*_vm.go` variants with the base files - `go fix` for context update (TODO: Fix internal/api.go's use of context) - Update travis config to test new versions * Remove Query APIs from appengine.log (#233) Remove deprecated log.Query api from appengine.log * Update docs (#234) * Remove the old Search API. * Remove the old Remote API. * Remove the old sockets API. * Temporarily remove blobstore API for v2 preview. * Revert "Temporarily remove blobstore API for v2 preview." This reverts commit 169bbdd4674a0fc862fd6a12a843eb2b3bba01cd. * Update docs for QA. * Update module API docs to indicate manual_scaling must be used for NumInstances, etc. * Update module API docs to indicate manual_scaling must be used for NumInstances, etc. * Remove old interfaces and interfaces that are not recommended (#236) * Remove the old deprecated channel interface. * Remove the old deprecated file interface. * Remove the old deprecated xmpp interface. * Removing the cloudsql interface, which is not recommended. * Removing the aebundler interface, which has been deprecated for some time. * Remove obsolete demo code (#238) * Remove obsolete demo code. Official appengine sample code referred by doc is in https://github.com/GoogleCloudPlatform/golang-samples * Replace Logs API with Stdout (#240) * Removed Logs API. * Remove dead code. * Added JSON encoding tests. * Emit single character severity in JSON message to trigger structured logs handling. * Prevent timestamp from being emitted on deployed logs. * Remove superfluous apis (#241) * Removed protos for channel/search/xmpp. * Remove protos for socket. * Add traceID/spanID to structured logs and chunk long logs (#242) * Moved logging related logic to separate file. * Added traceID/spanID to structured logs and log chunking. * Changes from code review. * Update go.mod for v2 * Revert v2 in the base directory. * Create the v2 in /v2 and revert the base directory back to 1.6.7 (#243) * Create a v2 directory for v2+ releases. * Update AppEngine imports to v2. * Update AppEngine imports to v2. * Clean up travis. We only currently support go 1.11+ * Temporarily disable testing go111+ with gopath until we can tag v2 properly. * Tidy v2/go.mod (#244) * Create a v2 directory for v2+ releases. * Update AppEngine imports to v2. * Update AppEngine imports to v2. * Clean up travis. We only currently support go 1.11+ * Temporarily disable testing go111+ with gopath until we can tag v2 properly. * Tidy go.sum * go mod tidy (#245) * Create a v2 directory for v2+ releases. * Update AppEngine imports to v2. * Update AppEngine imports to v2. * Clean up travis. We only currently support go 1.11+ * Temporarily disable testing go111+ with gopath until we can tag v2 properly. * Tidy go.sum * go mod tidy Co-authored-by: Steven Buss <sbuss@google.com> Co-authored-by: Kayla Nguyen <kaylanguyen@google.com> Co-authored-by: Jason Collins <jason.a.collins@gmail.com>
2021-06-15 20:57:49 +03:00
```
## Contributor License Agreements
Before we can accept your pull requests you'll need to sign a Contributor
License Agreement (CLA):
- **If you are an individual writing original source code** and **you own the
intellectual property**, then you'll need to sign an [individual CLA][indvcla].
- **If you work for a company that wants to allow you to contribute your work**,
then you'll need to sign a [corporate CLA][corpcla].
You can sign these electronically (just scroll to the bottom). After that,
we'll be able to accept your pull requests.
## Contributor Code of Conduct
As contributors and maintainers of this project,
and in the interest of fostering an open and welcoming community,
we pledge to respect all people who contribute through reporting issues,
posting feature requests, updating documentation,
submitting pull requests or patches, and other activities.
We are committed to making participation in this project
a harassment-free experience for everyone,
regardless of level of experience, gender, gender identity and expression,
sexual orientation, disability, personal appearance,
body size, race, ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* Public or private harassment
* Publishing other's private information,
such as physical or electronic
addresses, without explicit permission
* Other unethical or unprofessional conduct.
Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct.
By adopting this Code of Conduct,
project maintainers commit themselves to fairly and consistently
applying these principles to every aspect of managing this project.
Project maintainers who do not follow or enforce the Code of Conduct
may be permanently removed from the project team.
This code of conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior
may be reported by opening an issue
or contacting one or more of the project maintainers.
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0,
available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
[indvcla]: https://developers.google.com/open-source/cla/individual
[corpcla]: https://developers.google.com/open-source/cla/corporate