mirror of
https://github.com/GoogleCloudPlatform/vertex-ai-samples.git
synced 2026-09-26 14:42:04 +00:00
Ivan CheungandGitHub
aeaeddcc75
Updated PR template to emphasize need for a summary and checklist. Otherwise, people tend to skip this standard practice.
3.1 KiB
3.1 KiB
REQUIRED: Add a summary of your PR here, typically including why the change is needed and what was changed. Include any design alternatives for discussion purposes.
--- YOUR PR SUMMARY GOES HERE ---
REQUIRED: Fill out the below checklists or remove if irrelevant
- If you are opening a PR for
Official Notebooksunder 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 Notebooksunder 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 Contentunder 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.