From 55444707910d0803221859803be5b4afb79c1c3d Mon Sep 17 00:00:00 2001
From: Darren Loher <dloher@google.com>
Date: Fri, 8 Sep 2023 23:06:15 -0700
Subject: [PATCH] Add template for creating test requirement README files
 (#2106)

---
 .../ISSUE_TEMPLATE/new_test_requirement.md    | 16 +++++
 doc/test-requirements-template.md             | 71 +++++++++++++++++++
 2 files changed, 87 insertions(+)
 create mode 100644 doc/test-requirements-template.md

diff --git a/.github/ISSUE_TEMPLATE/new_test_requirement.md b/.github/ISSUE_TEMPLATE/new_test_requirement.md
index f3b950bdcc7..b2072b92ae5 100644
--- a/.github/ISSUE_TEMPLATE/new_test_requirement.md
+++ b/.github/ISSUE_TEMPLATE/new_test_requirement.md
@@ -1,5 +1,6 @@
 ---
 name: New featureprofiles test requirement
+<<<<<<< Updated upstream
 about: Use this template to document the requirements for a new test to be implemented.
 title: ''
 labels: enhancement
@@ -49,3 +50,18 @@ For example:
         *   Get
         *   Check
         *   Artifact
+=======
+about: Use this template to create an issue to assign and track implemenation of the code for a test.
+title: ''
+labels: enhancement
+assignees: ''
+---
+
+# Request for New Test Code Implementation Instructions
+
+* The label 'enhancement' is automatically set by this template.
+* Add a label for the test priority according to the test requirements. (p0, p1, p2)
+* Add a link in this issue description to the README.md for the test requirements.  For example:
+
+Implement code for [Test name here](<https://github.com/openconfig/featureprofiles/><insert link to the README.md file here>)
+>>>>>>> Stashed changes
diff --git a/doc/test-requirements-template.md b/doc/test-requirements-template.md
new file mode 100644
index 00000000000..61b2f0df0cf
--- /dev/null
+++ b/doc/test-requirements-template.md
@@ -0,0 +1,71 @@
+---
+name: New featureprofiles test requirement
+about: Use this template to document the requirements for a new test to be implemented.
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+# Instructions for this template
+
+Below is the required template for writing test requirements.  Good examples of test
+requirements include:
+
+* [TE-3.7: Base Hierarchical NHG Update](/feature/gribi/otg_tests/base_hierarchical_nhg_update/README.md)
+* [gNMI-1.13: Telemetry: Optics Power and Bias Current](https://github.com/openconfig/featureprofiles/blob/main/feature/platform/tests/optics_power_and_bias_current_test/README.md)
+* [RT-5.1: Singleton Interface](https://github.com/openconfig/featureprofiles/blob/main/feature/interface/singleton/otg_tests/singleton_test/README.md)
+
+# TestID-x.y: Short name of test here
+
+## Summary
+
+Write a few sentences or paragraphs describing the purpose and scope of the test.
+
+## Testbed type
+
+* Specify the .testbed topology file from the [topologies](https://github.com/openconfig/featureprofiles/tree/main/topologies) folder to be used with this test
+
+## Procedure
+
+* Sub Test #1 - Name of test
+  * Step 1
+  * Step 2
+  * Validation and pass fail criteria
+
+* Sub Test #2 - New of test
+  * Step 1
+  * Step 2
+  * Validation and pass fail criteria
+
+## Config Parameter Coverage
+
+Add list of OpenConfig 'config' paths used in this test, if any.
+
+## Telemetry Parameter Coverage
+
+Add list of OpenConfig 'state' paths used in this test, if any.
+
+## Protocol/RPC Parameter Coverage
+
+Add list of OpenConfig RPC's (gNMI, gNOI, gNSI, gRIBI) used in the list, if any.
+
+For example:
+
+* gNMI
+  * Set
+  * Subscribe
+* gNOI
+  * System
+    * KillProcess
+  * Healthz
+    * Get
+    * Check
+    * Artifact
+
+## Required DUT platform
+
+* Specify the minimum DUT-type:
+  * MFF - A modular form factor device containing LINECARDs, FABRIC and redundant CONTROLLER_CARD components
+  * FFF - fixed form factor
+  * vRX - virtual router device