CHORE: Added PR Formatter & Updated PR Template #104
+123
−36
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR refines the repository’s pull request template by adding an ADO Work Item section, updating summary guidance, and reorganizing the PR Title Guide.
- Adds a dedicated ADO Work Item Reference section for traceability.
- Introduces a Summary placeholder for Copilot-generated summaries and updates Additional Notes.
- Streamlines the overall template and moves the detailed Title Guide into an HTML comment.
Comments suppressed due to low confidence (2)
.github/PULL_REQUEST_TEMPLATE.MD:11
- The PR Title Guide is wrapped inside an HTML comment, so contributors won't see it. Consider moving it outside the comment block to ensure it’s visible in the rendered template.
<!--
.github/PULL_REQUEST_TEMPLATE.MD:4
- [nitpick] This line of hyphens won’t render as a markdown horizontal rule in all viewers. Use a proper
---on its own line for a consistent divider.
-------------------------------------------------------------------
bewithgaurav
changed the title
bewithgaurav
changed the title
bewithgaurav
changed the title
jahnvi480
approved these changes
Jun 27, 2025
gargsaumya
approved these changes
Jun 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ADO Work Item Reference
Summary
This pull request introduces updates to improve the pull request template and enforce formatting checks via GitHub Actions. The changes aim to standardize pull request descriptions and ensure compliance with specific guidelines for titles, work item references, and summary content.
Pull Request Template Updates:
.github/PULL_REQUEST_TEMPLATE.MD: Overhauled the pull request template to include a mandatory section for Azure DevOps (ADO) work item references, a structured guide for PR title prefixes, and placeholders for Copilot-generated summaries. Removed redundant sections such as solution implementation and testing details.Automated PR Formatting Checks:
.github/workflows/pr-format-check.yml: Added a GitHub Actions workflow to validate PR formatting. The workflow checks for valid PR title prefixes, presence of ADO work item links, and a meaningful summary section with at least 10 characters of content.