From 0165854c11e4c6e1f08cdf560e2aaa72111aa36d Mon Sep 17 00:00:00 2001 From: Keith Valin Date: Wed, 15 Jan 2025 14:25:53 -0500 Subject: [PATCH] Add issue and PR templates --- .github/issue_template.md | 14 ++++++++++++++ .github/pull_request_template.md | 16 ++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 .github/issue_template.md create mode 100644 .github/pull_request_template.md diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 0000000..7562375 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,14 @@ +# The problem +Write a short summary about what the reported problem/enhancement is. + +# Expected Behaviour +How should the program behave when it encounters +this issue? + +# Actual Behaviour +Describe how the program currently behaves when it +encounters this issue. + +# Screenshots or Relevant Logs +When applicable, attach a screenshot or relevant logs of +the issue. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..493851a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,16 @@ +# Description +What does this PR do? Give a short summary + +# Before/After Comparison +Give some examples of the before/after behavior +of the program. + +# Clerical Stuff +Mention the issue this PR works toward resolving. If the +PR completely solves the issue, use "This closes #x" +to close the issue out automatically. + +Mention the JIRA ticket of the issue, this helps keep +everything together so we can find this PR easily. + +Relates to JIRA: RPOPC-