mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-12-21 16:06:31 +01:00
91 lines
3.6 KiB
Markdown
91 lines
3.6 KiB
Markdown
|
# 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
|
||
|
|
|
||
|
|
Download and install the [Go App Engine SDK](https://cloud.google.com/appengine/docs/go/download). Make sure the `go_appengine` dir is in your `PATH`.
|
||
|
|
|
||
|
|
Set the `APPENGINE_DEV_APPSERVER` environment variable to `/path/to/go_appengine/dev_appserver.py`.
|
||
|
|
|
||
|
|
Run tests with `goapp test`:
|
||
|
|
|
||
|
|
```
|
||
|
|
goapp test -v google.golang.org/appengine/...
|
||
|
|
```
|
||
|
|
|
||
|
|
## 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
|