updates PR template to hint at how to link issues to pull request (op…

…ensearch-project#3730) Signed-off-by: Ashwin P Chandran <[email protected]> Signed-off-by: David Sinclair <[email protected]>
sikhote · Apr 24, 2023 · e32383d · e32383d
1 parent e6fdcdf
commit e32383d
Showing 1 changed file with 9 additions and 5 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,15 +1,19 @@
 ### Description
-[Describe what this change achieves]
-
+
+<!-- Describe what this change achieves-->
+
 ### Issues Resolved
-[List any issues this PR will resolve]
-
+
+<!-- List any issues this PR will resolve. -->
+<!-- Example: closes #1234 -->
+
 ### Check List
+
 - [ ] All tests pass
   - [ ] `yarn test:jest`
   - [ ] `yarn test:jest_integration`
   - [ ] `yarn test:ftr`
 - [ ] New functionality includes testing.
 - [ ] New functionality has been documented.
 - [ ] Update [CHANGELOG.md](./../CHANGELOG.md)
-- [ ] Commits are signed per the DCO using --signoff 
+- [ ] Commits are signed per the DCO using --signoff