Merge pull request #37 from meta-llama/fix_issue_template

fix: update issue templates for bug reports and feature requests

Author: heyjustinai

.github/ISSUE_TEMPLATE/bug.yml

@@ -1,77 +1,61 @@
 name: 🐛 Bug Report
-description: Create a report to help us reproduce and fix the bug
+description: Report a bug to help us improve llama-prompt-ops
 labels: ["bug"]
 body:
   - type: markdown
     attributes:
       value: >
-        #### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the
-        existing and past issues](https://github.com/meta-llama/llama-stack/issues).
+        Thanks for taking the time to report a bug! Please search [existing issues](https://github.com/justinai/llama-prompt-ops/issues) first to avoid duplicates.
 
   - type: textarea
-    id: system-info
+    id: bug-description
     attributes:
-      label: System Info
-      description: |
-        Please share your system info with us. You can use the following command to capture your environment information
-        python -m "torch.utils.collect_env"
-
+      label: What happened?
+      description: A clear description of the bug and what you expected to happen instead.
       placeholder: |
-        PyTorch version, CUDA version, GPU type, #num of GPUs...
+        I was trying to optimize prompts using the facility dataset, but...
+
+        Expected: The optimization should complete successfully
+        Actual: Got an error about missing configuration
     validations:
       required: true
 
-  - type: checkboxes
-    id: information-scripts-examples
-    attributes:
-      label: Information
-      description: 'The problem arises when using:'
-      options:
-        - label: "The official example scripts"
-        - label: "My own modified scripts"
-
   - type: textarea
-    id: bug-description
+    id: reproduction
     attributes:
-      label: 🐛 Describe the bug
-      description: |
-        Please provide a clear and concise description of what the bug is.
-
-        Please also paste or describe the results you observe instead of the expected results.
+      label: How to reproduce
+      description: Steps to reproduce the issue, including any commands or code.
       placeholder: |
-        A clear and concise description of what the bug is.
+        1. Run `llama-prompt-ops optimize --config configs/facility.yaml`
+        2. See error...
 
-        ```llama stack
-        # Command that you used for running the examples
+        ```bash
+        # Your command here
         ```
-        Description of the results
     validations:
       required: true
 
   - type: textarea
+    id: environment
     attributes:
-      label: Error logs
-      description: |
-       If you observe an error, please paste the error message including the **full** traceback of the exception. It may be relevant to wrap error messages in ```` ```triple quotes blocks``` ````.
-
+      label: Environment
+      description: Your Python version and any relevant system info.
       placeholder: |
-        ```
-        The error message you got, with the full traceback.
-        ```
-
+        - Python version: 3.9.0
+        - llama-prompt-ops version: 0.0.8
+        - OS: macOS 14.0
     validations:
-      required: true
-
+      required: false
 
   - type: textarea
-    id: expected-behavior
-    validations:
-      required: true
-    attributes:
-      label: Expected behavior
-      description: "A clear and concise description of what you would expect to happen."
-
-  - type: markdown
+    id: error-logs
     attributes:
-      value: >
-        Thanks for contributing 🎉!
+      label: Error logs (if any)
+      description: Paste any error messages or stack traces.
+      placeholder: |
+        ```
+        Traceback (most recent call last):
+          ...
+        ```
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -2,11 +2,8 @@ blank_issues_enabled: false
 
 contact_links:
   - name: Have you read the docs?
-    url: https://llama-stack.readthedocs.io/en/latest/index.html
-    about: Much help can be found in the docs
+    url: https://github.com/justinai/llama-prompt-ops/blob/main/README.md
+    about: Much help can be found in the README and documentation
   - name: Start a discussion
-    url: https://github.com/meta-llama/llama-stack/discussions/new
+    url: https://github.com/justinai/llama-prompt-ops/discussions/new
     about: Start a discussion on a topic
-  - name: Chat on Discord
-    url: https://discord.gg/llama-stack
-    about: Maybe chatting with the community can help

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,28 +1,35 @@
-name: 🚀 Feature request
-description: Request a new llama-stack feature
+name: 🚀 Feature Request
+description: Suggest a new feature for llama-prompt-ops
 labels: ["enhancement"]
 body:
 - type: textarea
-  id: feature-pitch
+  id: feature-description
   attributes:
-    label: 🚀 Describe the new functionality needed
-    description: >
-      A clear and concise description of _what_ needs to be built.
+    label: What feature would you like?
+    description: A clear description of the feature you'd like to see.
+    placeholder: |
+      I'd like to be able to...
+
+      This would help with...
   validations:
     required: true
 
 - type: textarea
-  id: feature-motivation
+  id: use-case
   attributes:
-    label: 💡 Why is this needed? What if we don't build it?
-    description: >
-      A clear and concise description of _why_ this functionality is needed.
+    label: What's your use case?
+    description: How would you use this feature? What problem does it solve?
+    placeholder: |
+      I'm working on optimizing prompts for customer support and need...
   validations:
     required: true
 
 - type: textarea
-  id: other-thoughts
+  id: additional-context
   attributes:
-    label: Other thoughts
-    description: >
-      Any thoughts about how this may result in complexity in the codebase, or other trade-offs.
+    label: Additional context
+    description: Any other details, examples, or screenshots that might help.
+    placeholder: |
+      Here's an example of what I'm trying to achieve...
+  validations:
+    required: false