mirror of
https://github.com/GoogleCloudPlatform/vertex-ai-samples.git
synced 2026-09-26 14:42:04 +00:00
3.3 KiB
3.3 KiB
If you are opening a PR for Notebooks under the official folder, follow this mandatory checklist:
- Use the notebook template as a starting point.
- Follow the style and grammar rules outlined in the above notebook template.
- Verify the notebook runs successfully in Colab since the automated tests cannot guarantee this even when it passes.
- Passes all the required automated checks
- You have consulted with a tech writer to see if tech writer review is necessary. If so, the notebook has been reviewed by a tech writer, and they have approved it.
- This notebook has been added to the CODEOWNERS file under
# Official Notebookssection, pointing to the author or the author's team. - The Jupyter notebook cleans up any artifacts it has created (datasets, ML models, endpoints, etc) so as not to eat up unnecessary resources.
If you are opening a PR for Notebooks under the community folder:
- This notebook has been added to the CODEOWNERS file under the
# Community Notebookssection, pointing to the author or the author's team.
If you are opening a PR for Community Content, and it will NOT be used on cloud.google.com/docs:
- Make sure your main
Content Directory Nameis descriptive, informative, and includes some of the key products and attributes of your content, so that it is differentiable from other content - The main content directory has been added to the CODEOWNERS file under the
# Community Contentsection, pointing to the author or the author's team.
If you are opening a PR for Community Content, and it will be used on cloud.google.com/docs:
- Make sure your main
Content Directory Nameis descriptive, informative, and includes some of the key products and attributes of your content, so that it is differentiable from other content - Use the notebook template for all the notebooks in your content directory.
- Follow the style and grammar rules outlined in the above notebook template.
- Verify each notebook runs successfully in Colab since the automated tests cannot guarantee this even when it passes.
- Passes all the required automated checks
- You have consulted with a tech writer to see if tech writer review is necessary. If so, the content has been reviewed by a tech writer, and they have approved it.
- This content has been added (/moved) to the CODEOWNERS file under the
# Official Community Contentsection (/from the# Community Contentsection), pointing to the author or the author's team. - Each notebook cleans up any artifacts it has created (datasets, ML models, endpoints, etc) so as not to eat up unnecessary resources.