docs: enhance pull request template with detailed sections #189
Conversation
|
@DeveshPatill is attempting to deploy a commit to the Dhanush Nehru's projects Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the GitHub pull request template to provide better structure and guidance for contributors. The update transforms a basic template into a comprehensive form that standardizes PR submissions and improves review efficiency.
- Adds structured sections including description, type of change, testing steps, and screenshots
- Expands the pre-merge checklist with additional quality assurance items
- Reorganizes content with clear separators and improved formatting for better readability
| ### PR Fixes: | ||
| - 1 | ||
| - 2 | ||
| Resolves # (issue number) |
There was a problem hiding this comment.
The format should be more specific. Consider using 'Resolves #' or 'Resolves #[issue-number]' to clearly indicate where the actual issue number should be placed.
| Resolves # (issue number) | |
| Resolves #<issue-number> |
Copilot uses AI. Check for mistakes.
| --- | ||
|
|
||
| ## Checklist before requesting a review | ||
| - [ ] I have pulled the latest changes from `main` branch |
There was a problem hiding this comment.
Grammar error: should be 'I have pulled the latest changes from the main branch' (missing 'the' article before 'main').
| - [ ] I have pulled the latest changes from `main` branch | |
| - [ ] I have pulled the latest changes from the `main` branch |
Copilot uses AI. Check for mistakes.
This pull request enhances the pull request template by adding structured sections for better clarity and review efficiency.
The new template includes:
1.A section to link related issues.
2.A detailed list for PR fixes.
3.A pre-merge checklist to ensure code quality and consistency.
This update will help contributors follow a consistent workflow, reduce review time, and prevent common mistakes such as untested changes or unresolved lint errors.
BEFORE CHANGES:
AFTER CHANGES:
