From 6614c3a53eac278bad71f07dfedeec41e7c07494 Mon Sep 17 00:00:00 2001 From: smttsp Date: Fri, 6 Oct 2023 08:49:45 -0400 Subject: [PATCH] Added the suggestion for PR_template --- .github/pull_request_template.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bc000a99..90c8fb7a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,8 @@ ## Summary -> What is the reason for this Pull-Request? +> What is the reason for this Pull-Request? If adding new functionality, please comment: +> a code snippet showcasing the end-to-end usage of your new methods, and the exact output +> from this code (print out any returned variables). @@ -12,17 +14,26 @@ ## Testing -> What testing have you done and verified? Please link to the one unit test that is most end-to-end check of your new functionality. It's ok if your unit tests are not yet comprehensive when you first open the PR, we can revisit them later! +> What testing have you done and verified? Please link to the one unit test +> that is most end-to-end check of your new functionality. It's ok if your +> unit tests are not yet comprehensive when you first open the PR, +> we can revisit them later! - ## Ticket(s) or Conversations -> What Git or Slack items (Issues, threads etc) are specifically related to this work? Please link them here. +> What Git or Slack items (Issues, threads, etc) that are specifically related to +> this work? Please link them here. +- ## References -> Include any extra information that may be helpful to reviewers of your Pull-Request here (e.g. relevant URLs or Wiki pages that could help give background information). If relevant, please include additional code snippets (and their outputs/return values) showing alternative ways to use your newly added methods. +> Include any extra information that may be helpful to reviewers of your +> Pull-Request here (e.g. relevant URLs or Wiki pages that could help give +> background information). If relevant, please include additional code snippets +> (and their outputs/return values) showing alternative ways to use your newly +> added methods. -