Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Latest commit

 

History

History
84 lines (58 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

84 lines (58 loc) · 3.49 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 Quality Checks

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/docs

You'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_notebook

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.

Contributor Guide

If you are new to contributing to open source, you can find helpful information in this contributor guide.

You may follow these steps to contribute:

  1. Fork the official repository. This will create a copy of the official repository in your own account.
  2. Sync the branches. This will ensure that your copy of the repository is up-to-date with the latest changes from the official repository.
  3. Work on your forked repository's dev branch. This is where you will make your changes to the code.
  4. Commit your updates on your forked repository's dev branch. This will save your changes to your copy of the repository.
  5. Submit a pull request to the official repository's dev branch. This will request that your changes be merged into the official repository.

image

Here are some additional things to keep in mind during the process:

  • Read the Google's Open Source Community Guidelines. The contribution guidelines will provide you with more information about the project and how to contribute.
  • Test your changes. Before you submit a pull request, make sure that your changes work as expected.
  • Be patient. It may take some time for your pull request to be reviewed and merged.