From 64d51657bfdb0a06aec76ac7de1c1711d0ecc463 Mon Sep 17 00:00:00 2001 From: Morgan Du Date: Sun, 25 Jul 2021 15:55:31 -0700 Subject: [PATCH] Copy PR template from ai-platform-samples (#5) * Copy Cloudbuild and GithubActions setup from ai-platform-samples for notebook testing (#1) * copy github actions * copy Cloud Build * add Dockerfile for cloud build * add notebook test_folders.txt to .cloud-build and update the file path * copy PR teamplate from ai-platform-samples --- .cloud-build/test_folders.txt | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 13 ++++++++----- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/.cloud-build/test_folders.txt b/.cloud-build/test_folders.txt index 87a9af1e3..a9523f341 100644 --- a/.cloud-build/test_folders.txt +++ b/.cloud-build/test_folders.txt @@ -1,3 +1,3 @@ notebooks/official tutorials/official -notebooks/notebook_template.ipynb +notebooks/notebook_template.ipynb \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0787bd943..f20750b9e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,9 @@ -Fixes # +Before submitting a Jupyter notebook, follow this mandatory checklist: -> It's a good idea to open an issue first for discussion. - -- [ ] Tests pass -- [ ] Appropriate changes to README are included in PR \ No newline at end of file +- [ ] Use the [notebook template](https://github.com/GoogleCloudPlatform/vertex-ai-samples/blob/master/notebooks/notebook_template.ipynb) 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, pointing to the author or the author's team. If the CODEOWNERS file doesn't exist, create one in the nearest folder that makes sense. +- [ ] The Jupyter notebook cleans up any artifacts it has created (datasets, ML models, endpoints, etc) so as not to eat up unnecessary resources.