diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000000..02a9be0f4cc11 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,38 @@ +# All SDK Contribution checklist: + +This checklist is used to make sure that common guidelines for a pull request are followed. +- [ ] **Please open PR in `Draft` mode if it is:** + - Work in progress or not intended to be merged. + - Encountering multiple pipeline failures and working on fixes. +- [ ] If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above. +- [ ] **I have read the [contribution guidelines](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md).** +- [ ] **The pull request does not introduce [breaking changes](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/breaking-change-rules.md).** + +### [General Guidelines and Best Practices](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md#general-guidelines) +- [ ] Title of the pull request is clear and informative. +- [ ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, [see this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md). + +### [Testing Guidelines](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md#testing-guidelines) +- [ ] Pull request includes test coverage for the included changes. + +### [SDK Generation Guidelines](https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md#sdk-generation-guidelines) +- [ ] The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only) +- [ ] The `*.csproj` and `AssemblyInfo.cs` files have been updated with the new version of the SDK. Please double check nuget.org current release version. + +## Additional management plane SDK specific contribution checklist: +Note: Only applies to `Microsoft.Azure.Management.[RP]` or `Azure.ResourceManager.[RP]` + +- [ ] Include updated [management metadata](https://github.com/Azure/azure-sdk-for-net/tree/master/eng/mgmt/mgmtmetadata). +- [ ] Update AzureRP.props to add/remove version info to maintain up to date API versions. + +### Management plane SDK Troubleshooting +- If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add `new service` label and/or contact assigned reviewer. +- If the check fails at the `Verify Code Generation` step, please ensure: + - Do not modify any code in generated folders. + - Do not selectively include/remove generated files in the PR. + - Do use `generate.ps1/cmd` to generate this PR instead of calling `autorest` directly. + Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version, + +### Old outstanding PR cleanup + Please note: + If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers. diff --git a/eng/CHECKENFORCER b/eng/CHECKENFORCER index c47ee8aeb674a..1d39370c9da5c 100644 --- a/eng/CHECKENFORCER +++ b/eng/CHECKENFORCER @@ -41,9 +41,11 @@ message: > # What if I am onboarding a new service? - Often, new services do not have validation pipelines associated with them, - in order to bootstrap pipelines for a new service, you can issue the following - command as a pull request comment: + Often, new services do not have validation pipelines associated with them. + In order to bootstrap pipelines for a new service, please perform following steps: + + ## For data-plane/track 2 SDKs + Issue the following command as a pull request comment: ``` /azp run prepare-pipelines @@ -55,4 +57,9 @@ message: > ``` /azp run net - [service] - ci - ``` \ No newline at end of file + ``` + + ## For track 1 management-plane SDKs + + Please open a separate PR and to your service SDK path in [this file](https://github.com/Azure/azure-sdk-for-net/blob/master/eng/pipelines/mgmt.yml). Once that PR has been merged, you can re-run the pipeline to trigger the verification. + \ No newline at end of file