We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
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.
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.
This project follows Google's Open Source Community Guidelines.
This library conforms to PEP 8
style guidelines and enforces an 80 character line width. It's recommended
that any contributor run the auto-formatter black
,
version 19.10b0 on the non-generated codebase whenever making changes. To get
started, first install the appropriate version of black
:
python -m pip install black==19.10b0
You can manually run the formatter on all non-generated code with the following command:
python -m black -l 80 -t py37 --exclude "/(v[0-9]+|\.eggs|\.git|_cache|\.nox|\.tox|\.venv|\.svn|_build|buck-out|build|dist)/" .
Alternatively, if you intend to contribute regularly, it might be easier to
append this script to the .git/hooks/pre-commit
file:
FILES=$(git diff --cached --name-only --diff-filter=ACMR "*.py" | grep -v "google/ads/google_ads/v.*")
echo "${FILES}" | xargs python -m black -l 80 -t py37
echo "${FILES}" | xargs git add