docs: Improved PR Template for Clarity and Readability#1740
Open
asholz wants to merge 1 commit intosphinx-labs:mainfrom
Open
docs: Improved PR Template for Clarity and Readability#1740asholz wants to merge 1 commit intosphinx-labs:mainfrom
asholz wants to merge 1 commit intosphinx-labs:mainfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Refined the PR template for better readability and usability. Removed redundant comments while keeping the structure clear, shortened explanations for better clarity, and added emojis to help distinguish categories visually.
Related Issue
N/A
Type of change
Motivation and Context
The previous template had some unnecessary comments and lengthy explanations, making it harder to scan quickly. These changes keep all the necessary details while improving clarity and ease of use.
How Has This Been Tested?
No code changes—just a documentation update. Reviewed for clarity and consistency.
Example Sphinx Deployment Script (if appropriate):
N/A