Skip to content

Latest commit

 

History

History
119 lines (86 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

119 lines (86 loc) · 4.12 KB

How to become a contributor and submit your own code

Contributor License Agreements

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.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

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.

Contributing A Patch

  1. Submit an issue describing your proposed change.
  2. The repo owner will respond to your issue promptly.
  3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
  4. Fork this repo, develop and test your code changes.
  5. Ensure that your code adheres to the existing style in the sample to which you are contributing.
  6. Ensure that your code has an appropriate set of unit tests which all pass.
  7. Submit a pull request.

Writing a new sample

Write samples according to the sample style guide.

Testing your code changes.

Install dependencies

To run the tests in a samples directory, you will need to install Composer.

First install the testing dependencies which are shared across all samples:

composer install -d testing/

Next, install the dependencies for the individual sample you're testing:

SAMPLES_DIRECTORY=translate
cd $SAMPLES_DIRECTORY
composer install

Environment variables

Some tests require specific environment variables to run. PHPUnit will skip the tests if these environment variables are not found. Run phpunit -v for a message detailing which environment variables are missing. Then you can set those environment variables to run against any sample project as follows:

export GOOGLE_PROJECT_ID=YOUR_PROJECT_ID
export GOOGLE_STORAGE_BUCKET=YOUR_BUCKET

If you have access to the Google Cloud Kokoro project, decrypt the .kokoro/secrets.sh.enc file and load those environment variables. Follow the instructions in .kokoro/secrets-example.sh.

If your tests require new environment variables, you can set them up in .kokoro/secrets.sh.enc so they pass on Kokoro. For instructions on managing those variables, view .kokoro/secrets-example.sh for more information.

Run the tests

Once the dependencies are installed and the environment variables set, you can run the tests in a samples directory.

cd $SAMPLES_DIRECTORY
# Execute the "phpunit" installed for the shared dependencies
PATH_TO_REPO=/path/to/php-docs-samples
$PATH_TO_REPO/testing/vendor/bin/phpunit

Use phpunit -v to get a more detailed output if there are errors.

Style

The Google Cloud Samples Style Guide is considered the primary guidelines for all Google Cloud samples.

Samples in this repository also follow the PSR2 and PSR4 recommendations. This is enforced using PHP CS Fixer, using the config in .php-cs-fixer.dist.php

Install that by running

composer global require friendsofphp/php-cs-fixer

Then to fix your directory or file run

php-cs-fixer fix . --config .php-cs-fixer.dist.php
php-cs-fixer fix path/to/file --config .php-cs-fixer.dist.php

The DLP snippets are an example of snippets following the latest style guidelines.