Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

43 lines (32 loc) · 1.65 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Code Reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Community Guidelines

This project follows Google's Open Source Community Guidelines.

Testing

NOTE: Be sure to run the following commands in the same VPC as the AlloyDB instance

  1. Setup local environment to work with virtualenv and nox if you haven't already, e.g. 
    python3 -m venv venv
source ./venv/bin/activate
pip install nox
  2. Set the environment variables. You can see an example of the environment variables needed by running cat .envrc.example
  3. Run gcloud auth application-default login
  4. Command to run the unit tests: nox -s unit-<PYTHON VERSION>
  5. Command to run the integration tests: nox -s system-<PYTHON VERSION>