Replace current PR template on Github #275
Merged
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
= Problem The default PR template that we inherit from the Delphix Github organization is too generic and some of its fields are not applicable to SDB. = Solution This patch introduces a new template that is more suitable for our needs. = Notes To Reviewers The choice of using `=` instead of `#` (Markdown Header) for the template sections is for the case that the submitter decides to copy paste the template in their commit description in git. The `#` character is used for comments in git descriptions so these section headers would disappear once the commit description is written.
prakashsurya
approved these changes
Apr 8, 2021
|
The rendering on the webpage is unfortunate ( |
ahrens
approved these changes
Apr 8, 2021
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.
= Problem
The default PR template that we inherit from the Delphix Github
organization is too generic and some of its fields are not applicable
to SDB.
= Solution
This patch introduces a new template that is more suitable for our
needs.
= Notes To Reviewers
The choice of using
=instead of#(Markdown Header) forthe template sections is for the case that the submitter decides
to copy paste the template in their commit description in git.
The
#character is used for comments in git descriptions sothese section headers would disappear once the commit description
is written.
= Testing
I've opened the following test PR where I verify that I can still see
the comments in the PR description when creating or editing it:
sdimitro/sdb#4