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 notebooks in this project are checked for formatting and style, to ensure a consistent experience. To test notebooks prior to submitting a pull request, you can follow these steps.
From a command-line terminal (e.g. from Vertex Workbench or locally), install the code analysis tools:
pip3 install --user -U nbqa black flake8 isort pyupgrade git+https://github.com/tensorflow/docsYou'll likely need to add the directory where these were installed to your PATH:
export PATH="$HOME/.local/bin:$PATH"Then, set an environment variable for your notebook (or directory):
export notebook="your-notebook.ipynb"Finally, run this code block to check for errors. Each step will attempt to automatically fix any issues. If the fixes can't be performed automatically, then you will need to manually address them before submitting your PR.
Note: For official, only submit one notebook per PR.
docker run -v ${PWD}:/setup/app gcr.io/cloud-devrel-public-resources/notebook_linter:latest your_notebookAll 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.