From 73979e2d1e5944bcebe4df4b78048d6f285b844f Mon Sep 17 00:00:00 2001 From: Mariana Rios Flores Date: Wed, 11 Dec 2024 15:46:44 -0800 Subject: [PATCH] Add sdk configuration changes template (#31842) * first try * templates added * update template * Update .github/PULL_REQUEST_TEMPLATE/sdk_configuration_template.md Co-authored-by: Ben Broderick Phillips --------- Co-authored-by: Ben Broderick Phillips --- .github/PULL_REQUEST_TEMPLATE.md | 2 ++ .../sdk_configuration_template.md | 25 +++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/sdk_configuration_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7839310f6d33..dd2098c4bf72 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,3 +5,5 @@ Switch to "Preview" on this description then select one of the choices below. Click here to open a PR for a Data Plane API. Click here to open a PR for a Control Plane (ARM) API. + +Click here to open a PR for only SDK configuration. diff --git a/.github/PULL_REQUEST_TEMPLATE/sdk_configuration_template.md b/.github/PULL_REQUEST_TEMPLATE/sdk_configuration_template.md new file mode 100644 index 000000000000..700c484f97f1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/sdk_configuration_template.md @@ -0,0 +1,25 @@ +# SDK configuration pull request + +## Purpose of this PR + +- [ ] Make changes to the SDK configuration only when there are no modifications to the API specification, eliminating the need for an ARM or Stewardship Board API review. + +## Due diligence checklist + +To merge this PR, you **must** go through the following checklist and confirm you understood +and followed the instructions by checking all the boxes: + +- [ ] I confirm this PR is modifying only SDK configurations, and not API related specifications. +- [ ] I have reviewed and used the respective `tspconfig.yaml` templates: + - [ARM tspconfig template](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml) + - [Data plane tspconfig template](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml) + +## Getting help + +- First, carefully read through this PR description, from top to bottom. Fill out the `Purpose of this PR` and `Due diligence checklist`. +- If you don't have permissions to remove or add labels to the PR, request `write access` per [aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories](https://aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories) +- To understand what you must do next to merge this PR, see the `Next Steps to Merge` comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state. +- For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix. +- If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. + This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes. +- If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR. \ No newline at end of file