docs: update PR template w/ onboarding comments #35
Conversation
This file contains 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
When viewed in GitHub, contributors won't mistakenly type between the empty lines.
CeeJayyy007
approved these changes
Feb 29, 2024
xamdoo
approved these changes
Mar 1, 2024
xamdoo
pushed a commit
that referenced
this pull request
Mar 1, 2024
* docs: update PR template w/ onboarding comments * docs: remove newlines within comments When viewed in GitHub, contributors won't mistakenly type between the empty lines.
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.
What change does this PR introduce?
The PR template sections has been redone, with descriptive comments added.
Why was this change needed?
The comments provide a smoother onboarding process leading up to the review process.
The updated sections encourage contributors to explain what changes are made and why they are made, which will help us gather more detailed contexts and reasons for the PR. They also provide a useful reminder to not explain how the changes are made, because that information is already provided by the diffs.
Since we're migrating from Jira to GitHub Projects, the issue ticket section has been removed.
To reduce noise, the type of change section has been removed in favor of using labels and issue titles to determine what kind of change has been made.
Other information (screenshots)
Checklist