Merge pull request #86 from linkorb/update-pull-request-template

Update pull request template to match linkorb/.github
linkorb · Oct 24, 2024 · f7306d4 · f7306d4
2 parents 2d101f7 + fa2b0cc
commit f7306d4
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,13 +1,13 @@
 ## Proposed changes
 
-Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
+<!-- Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
 
-If this relates to a card, please include a link to the card here. Additionally, please terminate the PR title with `#` and the card number, such as `Fix doomsday bug #1234`
+If this relates to a card, please include a link to the card here. Additionally, please terminate the PR title with `#` and the card number, such as `Fix doomsday bug #1234` -->
 
 ## Types of changes
 
-What types of changes does your code introduce?
-_Put an `x` in the boxes that apply_
+<!-- What types of changes does your code introduce?
+_Put an `x` in the boxes that apply_ -->
 
 - [ ] feat: non-breaking change which adds new functionality
 - [ ] fix: non-breaking change which fixes a bug or an issue
@@ -21,12 +21,12 @@ _Put an `x` in the boxes that apply_
 - [ ] ci: changes to continuous integration or continuous delivery scripts or configuration files
 - [ ] chore: general tasks or anything that doesn't fit the other commit types
 
-Please indicate if your PR introduces a breaking change
+<!-- Please indicate if your PR introduces a breaking change -->
 - [ ] Breaking change: fix or feature that would cause existing functionality to not work as expected
 
 ## Checklist
 
-_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
+<!-- _Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ -->
 
 - [ ] I have read the [Contributing](https://github.com/linkorb/.github/blob/master/CONTRIBUTING.md) doc
 - [ ] I have read the [Creating and reviewing pull requests at LinkORB guide](https://engineering.linkorb.com/topics/git/articles/reviewing-pr/) doc
@@ -35,4 +35,4 @@ _Put an `x` in the boxes that apply. You can also fill these out after creating
 
 ## Further comments
 
-If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...
+<!-- If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... -->
diff --git a/templates/pull_request_template.md.j2 b/templates/pull_request_template.md.j2
@@ -1,13 +1,13 @@
 ## Proposed changes
 
-Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
+<!-- Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
 
-If this relates to a card, please include a link to the card here. Additionally, please terminate the PR title with `#` and the card number, such as `Fix doomsday bug #1234`
+If this relates to a card, please include a link to the card here. Additionally, please terminate the PR title with `#` and the card number, such as `Fix doomsday bug #1234` -->
 
 ## Types of changes
 
-What types of changes does your code introduce?
-_Put an `x` in the boxes that apply_
+<!-- What types of changes does your code introduce?
+_Put an `x` in the boxes that apply_ -->
 
 - [ ] feat: non-breaking change which adds new functionality
 - [ ] fix: non-breaking change which fixes a bug or an issue
@@ -21,12 +21,12 @@ _Put an `x` in the boxes that apply_
 - [ ] ci: changes to continuous integration or continuous delivery scripts or configuration files
 - [ ] chore: general tasks or anything that doesn't fit the other commit types
 
-Please indicate if your PR introduces a breaking change
+<!-- Please indicate if your PR introduces a breaking change -->
 - [ ] Breaking change: fix or feature that would cause existing functionality to not work as expected
 
 ## Checklist
 
-_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
+<!-- _Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ -->
 
 - [ ] I have read the [Contributing](https://github.com/linkorb/.github/blob/master/CONTRIBUTING.md) doc
 - [ ] I have read the [Creating and reviewing pull requests at LinkORB guide](https://engineering.linkorb.com/topics/git/articles/reviewing-pr/) doc
@@ -35,4 +35,4 @@ _Put an `x` in the boxes that apply. You can also fill these out after creating
 
 ## Further comments
 
-If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...
+<!-- If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... -->