Issue templates

.github/ISSUE_TEMPLATE/1-bug.yml

@@ -0,0 +1,115 @@
+name: Bug Report
+description: An unexpected problem or behavior
+projects:
+  - cdisc-org/19
+type: Bug
+body:
+  - type: dropdown
+    id: standard
+    validations:
+      required: true
+    attributes:
+      label: Standard
+      multiple: true
+      options:
+        - CDISC ADaM
+        - CDISC Define-XML
+        - CDISC SDTM/SDTMIG
+        - CDISC SEND
+        - CDISC USDM
+        - FDA BR SDTM
+        - FDA BR SDTMIG
+        - FDA BR SEND
+        - FDA VR SDTMIG
+        - FDA VR SENDIG
+        - Custom
+  - type: input
+    id: reference_rule_id
+    validations:
+      required: true
+    attributes:
+      label: Reference Rule ID(s)
+  - type: input
+    id: core_id
+    attributes:
+      label: Conformance Rule ID(s) (if published in CORE)
+      value: CORE-
+  - type: input
+    id: jira
+    attributes:
+      label: JIRA Ticket
+      value: https://jira.cdisc.org/projects/CORERULES/issues/CORERULES-
+  - type: markdown
+    attributes:
+      value: "In the next fields, please provide a [Minimal Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example)."
+  - type: textarea
+    id: rule
+    validations:
+      required: true
+    attributes:
+      label: Rule YAML
+      render: YAML
+      value: |
+        Authorities: 
+          - Organization: 
+            Standards:
+              - Name: 
+                References:
+                  - Citations:
+                      - Cited Guidance: 
+                        Document: 
+                        Item: 
+                        Section: 
+                    Origin: 
+                    Rule Identifier: 
+                      Id: 
+                      Version: 
+                    Version: 
+                Version:
+        Check:
+          all:
+            - name: 
+              operator: 
+              value: 
+        Core:
+          Id: 
+          Status: 
+          Version: '1'
+        Description: 
+        Executability: Fully Executable
+        Match Datasets:
+          - Keys:
+              - 
+            Name: 
+        Operations:
+          - id: 
+            operator: 
+        Outcome:
+          Message: 
+          Output Variables:
+            -
+        Rule Type: 
+        Scope:
+        Sensitivity:
+  - type: textarea
+    id: test_data
+    validations:
+      required: true
+    attributes:
+      label: Sample Test Data File
+  - type: textarea
+    id: output
+    validations:
+      required: true
+    attributes:
+      label: Output report and/or log file
+  - type: textarea
+    id: expected
+    validations:
+      required: true
+    attributes:
+      label: Expected output
+  - type: textarea
+    id: additional_info
+    attributes:
+      label: Any Additional Information

.github/ISSUE_TEMPLATE/2-feature.yml

@@ -0,0 +1,109 @@
+name: Rule-related Feature Request
+description: A request for a new feature or enhancement related to a rule
+projects:
+  - cdisc-org/19
+type: Feature
+body:
+  - type: dropdown
+    id: standard
+    validations:
+      required: true
+    attributes:
+      label: Standard
+      multiple: true
+      options:
+        - CDISC ADaM
+        - CDISC Define-XML
+        - CDISC SDTM/SDTMIG
+        - CDISC SEND
+        - CDISC USDM
+        - FDA BR SDTM
+        - FDA BR SDTMIG
+        - FDA BR SEND
+        - FDA VR SDTMIG
+        - FDA VR SENDIG
+        - Custom
+  - type: input
+    id: reference_rule_id
+    validations:
+      required: true
+    attributes:
+      label: Reference Rule ID(s)
+  - type: input
+    id: core_id
+    attributes:
+      label: Conformance Rule ID(s) (if published in CORE)
+      value: CORE-
+  - type: input
+    id: jira
+    attributes:
+      label: JIRA Ticket
+      value: https://jira.cdisc.org/projects/CORERULES/issues/CORERULES-
+  - type: markdown
+    attributes:
+      value: "In the next fields, please provide a [Minimal Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example)."
+  - type: textarea
+    id: rule
+    validations:
+      required: true
+    attributes:
+      label: Proposed Rule YAML
+      render: YAML
+      value: |
+        Authorities: 
+          - Organization: 
+            Standards:
+              - Name: 
+                References:
+                  - Citations:
+                      - Cited Guidance: 
+                        Document: 
+                        Item: 
+                        Section: 
+                    Origin: 
+                    Rule Identifier: 
+                      Id: 
+                      Version: 
+                    Version: 
+                Version:
+        Check:
+          all:
+            - name: 
+              operator: 
+              value: 
+        Core:
+          Id: 
+          Status: 
+          Version: '1'
+        Description: 
+        Executability: Fully Executable
+        Match Datasets:
+          - Keys:
+              - 
+            Name: 
+        Operations:
+          - id: 
+            operator: 
+        Outcome:
+          Message: 
+          Output Variables:
+            -
+        Rule Type: 
+        Scope:
+        Sensitivity:
+  - type: textarea
+    id: test_data
+    validations:
+      required: true
+    attributes:
+      label: Attach any sample test data file(s)
+  - type: textarea
+    id: expected
+    validations:
+      required: true
+    attributes:
+      label: Expected output
+  - type: textarea
+    id: additional_info
+    attributes:
+      label: Any Additional Information

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,4 @@
+contact_links:
+  - name: CORE Discussion Forum
+    url: https://github.com/cdisc-org/cdisc-rules-engine/discussions/categories/general
+    about: Please ask and answer general questions here.

cdisc_rules_engine/dataset_builders/base_dataset_builder.py

@@ -109,17 +109,18 @@ def get_dataset_contents(self, **kwargs):
 
     def get_define_xml_item_group_metadata_for_dataset(
         self, dataset_metadata: SDTMDatasetMetadata
-    ) -> List[dict]:
+    ) -> dict:
         """
         Gets Define XML item group metadata
-        returns a list of dictionaries containing the following keys:
+        returns a dictionary containing the following keys:
             "define_dataset_name"
             "define_dataset_label"
             "define_dataset_location"
             "define_dataset_class"
             "define_dataset_structure"
             "define_dataset_is_non_standard"
             "define_dataset_variables"
+            "define_dataset_variable_order"
             "define_dataset_key_sequence"
             "define_dataset_has_no_data"
         """
@@ -142,6 +143,7 @@ def get_define_xml_item_group_metadata_for_domain(self, domain: str) -> List[dic
             "define_dataset_structure"
             "define_dataset_is_non_standard"
             "define_dataset_variables"
+            "define_dataset_variable_order"
             "define_dataset_key_sequence"
             "define_dataset_has_no_data"
         """

cdisc_rules_engine/dataset_builders/contents_define_dataset_builder.py

@@ -26,6 +26,7 @@ def build(self):
         define_dataset_name - dataset name from define_xml
         define_dataset_structure - dataset structure
         define_dataset_variables - list of variables in the dataset
+        define_dataset_variable_order - ordered list of variables in the dataset
 
         ...,
         """