mirror of
https://github.com/GoogleCloudPlatform/vertex-ai-samples.git
synced 2026-09-26 14:42:04 +00:00
When opening a PR, the CODEOWNERS and instructions hyperlinks throw a 404 error because they point to a URL that has been changed. Fixing these hyperlinks.
2.8 KiB
2.8 KiB
If you are opening a PR for Official Notebooks under the notebooks/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 can locally test for formatting and linting with these instructions.
- 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 the
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 Community Notebooks under the notebooks/community folder:
- This notebook has been added to the CODEOWNERS file under the
Community Notebookssection, pointing to the author or the author's team. - Passes all the required formatting and linting checks. You can locally test with these instructions.
If you are opening a PR for Community Content under the community-content folder:
- 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. - Passes all the required formatting and linting checks. You can locally test with these instructions.