From 867c83457133a1fa936ff32b08680d8c0f193001 Mon Sep 17 00:00:00 2001
From: Trevor Cooper <tcooper@sdsc.edu>
Date: Tue, 24 Aug 2021 13:49:03 -0700
Subject: [PATCH] Update issue and add pull request template (#39)

* rename template for clarity

* update template to incorporate suggestion from @akatch

* add pull request template

* request issue creation before pull request

* Update openqa-test-suite-pull-request-template.md

Adding akatch's suggestion.

Co-authored-by: StackKorora <42156355+StackKorora@users.noreply.github.com>
---
 .../openqa-test-suite---needle-update.md      | 26 ---------------
 .../openqa-test-suite-needle-update.md        | 28 ++++++++++++++++
 ...openqa-test-suite-pull-request-template.md | 33 +++++++++++++++++++
 3 files changed, 61 insertions(+), 26 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE/openqa-test-suite---needle-update.md
 create mode 100644 .github/ISSUE_TEMPLATE/openqa-test-suite-needle-update.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/openqa-test-suite-pull-request-template.md

diff --git a/.github/ISSUE_TEMPLATE/openqa-test-suite---needle-update.md b/.github/ISSUE_TEMPLATE/openqa-test-suite---needle-update.md
deleted file mode 100644
index 2451168d..00000000
--- a/.github/ISSUE_TEMPLATE/openqa-test-suite---needle-update.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
-name: openQA test suite / needle update
-about: This template provide basis for general case submission of issue to resolve
-  openQA test failure via test and/or needle updates
-title: Test suite failure for [insert_test_suite_name_here] on [DISTRI-VERSION-FLAVOR-ARCH]
-labels: ''
-assignees: ''
-
----
-
-## Describe Issue
-
-Please describe the issue as completely as possible so that an appropriate fix may be developed.
-
-| Test Suite | `<please_insert_test_suite_name_here>` |
-|---|---|
-| Result | <please_insert_previous_test_result_here> |
-| Scheduled product | `<please_inster_the_schedule_product_here>` |
-| Test module | `<full_path_to_test_module_to_be_fixed>` |
-| Analysis | *<insert_error_message_produced_in_test>*<br><insert_any_additional_details_that_may_assist_in_resolution> |
-
-## Planned Action
-- Please provide suggested resolution steps if they are know.
-
-## Special Notes
-- Please provide any special instructions/information that may help testing progress more quickly. For example... Test can run from `disk_64bit_cockpit.qcow2` image if it is saved and stored appropriately in the test system. There is no need to run from beginning and/or trigger from `install_default_upload@64bit`.
diff --git a/.github/ISSUE_TEMPLATE/openqa-test-suite-needle-update.md b/.github/ISSUE_TEMPLATE/openqa-test-suite-needle-update.md
new file mode 100644
index 00000000..11eb885e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/openqa-test-suite-needle-update.md
@@ -0,0 +1,28 @@
+---
+name: openQA test suite and/or needle update
+about: Report openQA test failure and/or needle update requirement
+title: [Test Suite Failure] for [insert_test_suite_name_here] on [DISTRI-VERSION-FLAVOR-ARCH]
+labels: [test suite]
+assignees: ''
+
+---
+
+## Describe Issue
+
+Please describe the issue as completely as possible so that an appropriate fix may be developed.
+
+| Test Suite        | <!-- eg: `install_default@uefi` --> |
+|-------------------|-------------------------------------|
+| Result            | <!-- eg: **failed** ( 04:46 minutes ) --> |
+| Scheduled product | <!-- eg: `rocky-8.4-dvd-iso-x86_64` --> |
+| Test module       | <!-- eg: `/var/lib/openqa/share/tests/rocky/tests/_impacted_test_module_here.pm` --> |
+| Analysis          | <!-- eg: *Analysis	Test died: no candidate needle with tag(s) 'anaconda_help_progress_link' matched* --> |
+
+<!-- Provide any additional relevant detail here -->
+
+## Planned Action
+<!-- Outline the steps that should be taken to address this issue -->
+
+## Special Notes
+<!-- Please provide any special instructions/information that may help testing progress more quickly -->
+<!-- For example... Test can run from `disk_64bit_cockpit.qcow2` image if it is saved and stored appropriately in the test system. There is no need to run from beginning and/or trigger from `install_default_upload@64bit`. -->
diff --git a/.github/PULL_REQUEST_TEMPLATE/openqa-test-suite-pull-request-template.md b/.github/PULL_REQUEST_TEMPLATE/openqa-test-suite-pull-request-template.md
new file mode 100644
index 00000000..bc8b32dc
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/openqa-test-suite-pull-request-template.md
@@ -0,0 +1,33 @@
+---
+name: openQA test suite and/or needle Pull Request
+about: Submit openQA test fix and/or needle updates
+title: Test Suite: [insert_test_suite_name_here] on [DISTRI-VERSION-FLAVOR-ARCH]
+labels: 'test suite'
+assignees: ''
+
+---
+
+# Description
+
+<!-- Provide a brief description of the pull request here -->
+<!-- If applicable, specify the issue number this PR fixes -->
+
+<!-- eg: Fixes #999 -->
+
+<!-- If no Issue exists it is highly recommended that you create an issue first, assigning it to yourself and then return here to provide the pull request. -->
+
+# How Has This Been Tested?
+
+<!-- Indicate what you have done to test this PR, with screenshots if appropriate -->
+<!-- At a minimum, please include the following: -->
+<!-- * The command you used to trigger a passing test -->
+<!-- * Criteria for a successful test (eg: suite install_minimal@uefi passes) -->
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] Any dependent changes have been merged and published in downstream modules