Merge pull request hashicorp#25103 from hashicorp/rcsk/pr-template-an…

…d-guide-update

Docs: Adding PR template and updating PR guide

.github/pull_request_template.md

@@ -0,0 +1,76 @@
+<!--  All Submissions -->
+
+
+## Community Note
+<!-- Please leave the community note as is. -->
+* Please vote on this PR by adding a :thumbsup: [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original PR to help the community and maintainers prioritize for review
+* Please do not leave "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review
+
+
+## PR Checklist
+
+- [ ] I have followed the guidelines in our [Contributing Documentation](../blob/main/contributing/README.md).
+- [ ] I have checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change.
+- [ ] I have checked if my changes close any open issues. If so please include appropriate [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) below.
+- [ ] I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work. 
+For example: “`resource_name_here` - description of change e.g. adding property `new_property_name_here`”
+
+
+
+<!-- You can erase any parts of this template below this point that are not applicable to your Pull Request. -->
+
+
+## New Feature Submissions
+
+- [ ] My submission includes Test coverage as described in the [Contribution Guide](../blob/main/contributing/topics/guide-new-resource.md) and the tests pass. (if this is not possible for any reason, please include details of why below)
+
+
+## Changes to existing Resource / Data Source
+
+- [ ] I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
+- [ ] I have written new tests for my resource or datasource changes.
+- [ ] I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
+- [ ] (For changes that include a **state migration only**). I have manually tested the migration path between relevant versions of the provider.
+
+
+## Documentation Changes
+
+- [ ] Documentation is written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
+
+
+## Description
+
+<!-- Please include a description below with the reason for the PR, what it is doing, what it is trying to accomplish, and anything relevant for a reviewer to know. 
+
+If this is a breaking change for users please detail how it cannot be avoided and why it should be made in a minor version of the provider -->
+
+## Testing Logs/Evidence
+
+<!-- Please include your testing evidence here or an explanation on why no testing evidence can be provided. 
+For state migrations please test the changes locally and provide details here, such as the versions involved in testing the migration path. For further details on testing state migration changes please see our guide on [state migrations](https://github.com/hashicorp/terraform-provider-azurerm/blob/main/contributing/topics/guide-state-migrations.md#testing) in the contributor documentation. -->
+
+## Related Issue(s)
+Fixes #0000
+
+## Change Log
+Below please provide what should go into the changelog (if anything) conforming to the [Changelog Format documented here](../blob/main/contributing/topics/maintainer-changelog.md).
+
+<!-- Replace the changelog example below with your entry. One resource per line. -->
+
+* `azurerm_resource` - support for the `thing1` property [GH-00000]
+
+
+<!-- What type of PR is this? -->
+This is a (please select all that apply):
+
+- [ ] Bug Fix
+- [ ] New Feature (ie adding a service, resource, or data source)
+- [ ] Enhancement
+- [ ] Breaking Change
+
+
+
+> [!NOTE] 
+> If this PR changes meaningfully during the course of review please update the title and description as required.
+
+

contributing/topics/guide-opening-a-pr.md

@@ -16,11 +16,11 @@ As a general rule, the smaller the PR the quicker it's merged - as such when upg
 
 We also recommend not opening a PR based on your `main` branch. By doing this any changed pushed to the PR may inadvertently be also pushed to your `main` branch without warning.
 
-Due to the high volume of PR's on the project and to ensure maintainers are able to focus on changes which are ready to review, please do not open Draft PRs or work that is not yet ready to be reviewed.
+Due to the high volume of PRs on the project and to ensure maintainers are able to focus on changes which are ready to review, please do not open Draft PRs or work that is not yet ready to be reviewed.
 
 ## Process
 
-Pull Requests generally go through a number of phrases which vary slightly depending on what's being changed.
+Pull Requests generally go through a number of phases which vary slightly depending on what's being changed.
 
 The following guides cover the more common scenarios we see:
 
@@ -46,7 +46,7 @@ In general, Pull Requests which add/change either code or SDK's go through the f
 * Don't send the PR from your `main` branch.
 * The PR Title is obvious/clear about what it's changing (see `Title` below).
 * The PR Body contains a summary of what/why is included (see `Body` below).
-* any linked Issues
+* any linked Issues (see `Body` below)
 
 ### Title
 
@@ -73,12 +73,67 @@ Examples of poorly written PR titles:
 - `add cosmos property`
 - `support encryption, local_authentication_enabled properties`
 
-### Description
+### Body
 
-A PR should include a brief description of the reason for the PR, what it is doing, what it is trying to accomplish, and anything relevant for a reviewer to know. It also helps to paste the output from running the accpetance tests.
+An example of our PR template is shown below.
 
-It should also link to any related issues/PRs and include the following for any issues that it will resolve:
+#### Community Note
+<!-- Please leave the community note as is. -->
 
+* Please vote on this PR by adding a :thumbsup: [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original PR to help the community and maintainers prioritize for review
+* Please do not leave "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review
+
+ #### PR Checklist
+
+- [ ] Have you followed the guidelines in our [Contributing Documentation](../contributing/README.md)?
+- [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change?
+- [ ] Have you used a meaningful PR description to help maintainers and other users understand this change and help prevent duplicate work?
+Example: 
+“`resource_name_here` - description of change e.g. adding property `new_property_name_here`”
+- [ ] Do your changes close any open issues? If so please include appropriate [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) below.
+
+<!-- You can erase any parts of this template below this point that are not applicable to your Pull Request. -->
+
+#### New Feature Submissions
+
+- [ ] Does your submission include Test coverage as described in the [Contribution Guide](../contributing/topics/guide-new-resource.md) and the tests pass? (if this is not possible for any reason, please include details of why below)
+
+#### Changes to existing Resource / Data Source
+
+- [ ] Have you added an explanation of what your changes do and why you'd like us to include them? (This may be covered by linking to an issue above, but may benefit from additional explanation)
+- [ ] Have you written new tests for your resource or datasource changes?
+- [ ] Have you successfully run tests with your changes locally? If not, please provide details on testing challenges that prevented you running the tests.
+
+#### Documentation Changes
+
+- [ ] Documentation is written in International English.
+- [ ] Documentation is written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
+
+#### Description
+
+<!-- Please include a description below with the reason for the PR, what it is doing, what it is trying to accomplish, and anything relevant for a reviewer to know. It also helps to paste the output from running the acceptance tests. -->
+
+
+#### Related Issue(s)
+ Use [linking keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) here like "fixes", "closes", "resolves", etc:
  ```
- fixes #1234,#5678
+ Fixes #1234, fixes #5678, fixes #9101
  ```
+#### Change Log
+
+[Changelog Format](https://github.com/hashicorp/terraform-provider-azurerm/blob/main/contributing/topics/maintainer-changelog.md)
+
+<!-- Replace the changelog example below with your entry. One resource per line. -->
+
+* `azurerm_resource` - support for the `thing1` property [GH-00000]
+
+<!-- What type of PR is this? -->
+
+- [ ] Bug Fix
+- [ ] New Feature
+
+
+> [!NOTE] If this PR changes meaningfully during the course of review please update the title and description as required.
+
+
+