Merge branch 'paperwork' into 'main'

andrewkaufman · andrewkaufman · commit ba6b153f7810 · 2025-09-23T13:09:23.000-07:00
Revamp GitHub templates

See merge request omniverse/newton-physics/mujoco-usd-converter!95
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -3,7 +3,6 @@
 
 name: Bug Report
 description: File a bug report
-title: "[BUG]: "
 labels: ["bug"]
 
 body:
@@ -22,29 +21,30 @@ body:
       required: true
 
   - type: dropdown
-    id: installation-method
+    id: installation_method
     attributes:
       label: Did you install official release artifacts or build from source?
-      multiple: true
       options:
         - Official release artifacts
         - Built from Source
+    validations:
+      required: true
 
   - type: dropdown
     id: modifications
     attributes:
       label: Did you modify the sdist, whl, or source code (including the pyproject.toml or uv.lock)?
-      multiple: true
       options:
-        - Yes
-        - No
+        - "No"
+        - "Yes"
+    validations:
+      required: true
 
   - type: input
-    id: py-version
+    id: py_version
     attributes:
       label: Python Version
       description: What version of Python are you using?
-      placeholder: "example: 3.10 or None"
     validations:
       required: true
 
@@ -53,7 +53,7 @@ body:
     attributes:
       label: Operating System
       description: What Operating System / Platform are you using?
-      placeholder: "example: windows-x86_64"
+      placeholder: "example: Ubuntu 22.04 Linux x86_64"
     validations:
       required: true
 
@@ -71,7 +71,7 @@ body:
     attributes:
       label: Minimum reproducible example
       description: Please supply a minimum reproducible example here
-      render: shell
+      render: python
 
   - type: textarea
     id: logs
@@ -80,12 +80,6 @@ body:
       description: Please paste relevant error and log output here
       render: shell
 
-  - type: textarea
-    id: misc
-    attributes:
-      label: Other/Misc.
-      description: Please enter any other helpful information here.
-
   - type: checkboxes
     id: terms
     attributes:
@@ -94,5 +88,5 @@ body:
       options:
         - label: I agree to follow mujoco-usd-converter Code of Conduct
           required: true
-        - label: I have searched the [open bugs](https://github.com/newton-physics/mujoco-usd-converter/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and have found no duplicates
+        - label: I have searched the [open issues](https://github.com/newton-physics/mujoco-usd-converter/issues) and have found no duplicates
           required: true
diff --git a/.github/ISSUE_TEMPLATE/documentation_request.yml b/.github/ISSUE_TEMPLATE/documentation_request.yml
@@ -1,33 +1,20 @@
 # SPDX-FileCopyrightText: Copyright (c) 2023-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-name: Documentation - New Documentation Request
-description: Request additions to documentation
-title: "[DOC]: "
-labels: ["doc"]
+name: Documentation
+description: Request changes or additions to documentation
+labels: ["documentation"]
 
 body:
   - type: markdown
     attributes:
       value: |
         Thanks for taking the time to improve our documentation!
 
-  - type: dropdown
-    id: criticality
-    attributes:
-      label: How would you describe the priority of this documentation request
-      options:
-        - Critical (currently preventing usage)
-        - High
-        - Medium
-        - Low (would be nice)
-    validations:
-      required: true
-
   - type: textarea
     id: problem
     attributes:
-      label: Describe the future/missing documentation
+      label: Describe the changes or additions to documentation
       placeholder: A code snippet mentions function foo(args) but I cannot find any documentation on it.
     validations:
       required: true
@@ -47,5 +34,5 @@ body:
       options:
         - label: I agree to follow mujoco-usd-converter Code of Conduct
           required: true
-        - label: I have searched the [open bugs](https://github.com/newton-physics/mujoco-usd-converter/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and have found no duplicates
+        - label: I have searched the [open issues](https://github.com/newton-physics/mujoco-usd-converter/issues) and have found no duplicates
           required: true
diff --git a/.github/ISSUE_TEMPLATE/documentation_request_correction.yml b/.github/ISSUE_TEMPLATE/documentation_request_correction.yml
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,51 @@
+# SPDX-FileCopyrightText: Copyright (c) 2023-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+name: Feature Request
+description: Request new or improved functionality or changes to existing functionality
+labels: ["enhancement"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+
+  - type: dropdown
+    id: new_or_improvement
+    attributes:
+      label: Is this a new feature, an improvement, or a change to existing functionality?
+      options:
+        - New Feature
+        - Improvement
+        - Change
+    validations:
+      required: true
+
+  - type: textarea
+    id: Feature_Description
+    attributes:
+      label: Feature Description
+      description: Please provide clear description of the feature you request
+      placeholder: >
+        For new feature request, consider using the following format to describe the feature from the end-user perspective:
+          As a <persona>, I <want to>, <so that>.
+    validations:
+      required: true
+
+  - type: textarea
+    id: misc
+    attributes:
+      label: Additional context or alternatives
+      description: Add any other context, code examples, references to existing implementations, or alternatives you have considered
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/newton-physics/mujoco-usd-converter/blob/HEAD/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow mujoco-usd-converter Code of Conduct
+          required: true
+        - label: I have searched the [open issues](https://github.com/newton-physics/mujoco-usd-converter/issues) and have found no duplicates
+          required: true
diff --git a/.github/ISSUE_TEMPLATE/feature_request_form.yml b/.github/ISSUE_TEMPLATE/feature_request_form.yml
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -5,5 +5,3 @@
 
 ## Checklist
 - [ ] I am familiar with the [Contributing Guidelines](https://github.com/newton-physics/mujoco-usd-converter/blob/HEAD/CONTRIBUTING.md).
-- [ ] I understand that this Pull Request will not be merged, it is only for demonstration & discussion purposes.
-- [ ] I do not require attribution for any code submitted via this Pull Request, and will not pursue attribution for any code resembling this submission which may be added to this repository in the future.
