When I was recently raising PR, I realized that the template could be made better. First of all, the changes word from the top should be removed and text below the headings should be commented so that contributors doesn't have to manually delete it. Also, it should be fixes instead of relates to because most of the time, the PR that gets merged most likely closes the issue. Changing it means that maintainers won't have to manually close the issue.
Before:
## Documentation Update
**Related Feature:**
Please include the branch name where you have made changes or added new features/scenario that we need on the website (e.g., `krkn/new_scenario`) in the title of this PR.
**Changes:**
Describe the documentation updates made for the feature.
After:
## Documentation Update
Fixes #<!-- issue number -->
<!--
Please include the branch name where you have made changes or added new
features/scenario that we need on the website (e.g., `krkn/new_scenario`)
in the title of this PR.
-->
**Changes:**
<!-- Describe the documentation updates made for the feature. -->
When I was recently raising PR, I realized that the template could be made better. First of all, the changes word from the top should be removed and text below the headings should be commented so that contributors doesn't have to manually delete it. Also, it should be fixes instead of relates to because most of the time, the PR that gets merged most likely closes the issue. Changing it means that maintainers won't have to manually close the issue.
Before:
After: