From 15c88fb0ff297f1d4478b47d7ec5e8e55b57fd5e Mon Sep 17 00:00:00 2001 From: Victor Schappert Date: Fri, 9 Feb 2024 14:10:11 -0800 Subject: [PATCH] Create pull request template for schema changes https://github.com/OvertureMaps/schema-wg/issues/183 --- .../documentation_update.md | 4 --- .github/pull_request_template.md | 33 +++++++++++++++++++ 2 files changed, 33 insertions(+), 4 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/documentation_update.md create mode 100644 .github/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation_update.md b/.github/PULL_REQUEST_TEMPLATE/documentation_update.md deleted file mode 100644 index c6d981af..00000000 --- a/.github/PULL_REQUEST_TEMPLATE/documentation_update.md +++ /dev/null @@ -1,4 +0,0 @@ -# Update to the Schema Documentation Website - -To view the changes this PR introduces to the documentation website, view the [https://dfhx9f55j8eg5.cloudfront.net/pr/](Page Preview) - diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..2542b78a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,33 @@ +# Description + +*Brief description of the business purpose and effect of the pull request.* + +TODO. + +# Reference + +*List of relevant links to GitHub issues, PRs, and other documentation.* + +1. TODO. + +# Testing + +*Brief description of the testing done for this change showing why you are confident it works as expected and does not introduce regressions. Provide sample output data where appropriate.* + +TODO. + +# Checklist + +*Checklist of tasks commonly-associated with schema pull requests. Please review the relevant checklists and ensure you do all the tasks that are required for the change you made.* + +1. [ ] Add relevant examples. +2. [ ] Add relevant counterexamples. +3. [ ] Update in-schema documentation using plain English written in complete sentences, if an update is required. +4. [ ] Update Docusaurus documentation, if an update is required. +5. [ ] Review change with Overture technical writer to ensure any advanced documentation needs will be taken care of, unless the change is trivial and would not affect the documentation. + +# Documentation Website + +*Update the hyperlink below to put the pull request number in.* + +[Docs preview for this PR.](https://dfhx9f55j8eg5.cloudfront.net/pr/)