We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.
Please fill out either the individual or corporate Contributor License Agreement (CLA).
- If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA] (https://developers.google.com/open-source/cla/individual).
- If you work for a company that wants to allow you to contribute your work, then you'll need to sign a [corporate CLA] (https://developers.google.com/open-source/cla/corporate).
Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
- Submit an issue describing your proposed change to the repo in question.
- The repo owner will respond to your issue promptly.
- If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
- Fork the desired repo, develop and test your code changes.
- Ensure that your code adheres to the existing style in the sample to which you are contributing. Refer to the [Google Cloud Platform Samples Style Guide] (https://github.com/GoogleCloudPlatform/Template/wiki/style.html) for the recommended coding standards for this organization.
- Ensure that your code has an appropriate set of unit tests which all pass.
- Submit a pull request.
Set up application default credentials
by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS to the
path to a service account key JSON file and GOOGLE_CLOUD_PROJECT to your
Google Cloud project ID:
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/your/credentials.json
export GOOGLE_CLOUD_PROJECT=YOUR_PROJECT_ID
These tests use phpunit/phpunit:^7. You can install this with composer
globally:
composer global require phpunit/phpunit:^7
These tests also use google/cloud-tools:dev-main. You can install this with
composer globally:
composer global require google/cloud-tools:dev-main
Now you can run the tests in the samples directory!
cd $SAMPLES_DIRECTORY
phpunit
Use phpunit -v to get a more detailed output if there are errors.
Samples in this repository follow the PSR2 and PSR4 recommendations. This is enforced using PHP CS Fixer.
Install that by running
composer global require friendsofphp/php-cs-fixer
Then to fix your directory or file run
php-cs-fixer fix .
php-cs-fixer fix path/to/file