issue templates

Author: lchoquel

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,47 +1,91 @@
-name: 🐛 Report an Issue
-description: File a bug report to help improve Pipelex
-title: "bug: "
-labels: ["bug-unverified"]
+name: "🐞 Bug report"
+description: "Report a reproducible problem with the library"
+type: Bug
+labels:
+  - status:needs-triage
+
 body:
+  - type: markdown
+    attributes:
+      value: |
+        **Thanks for taking the time to file a bug!**
+        Please complete **all required sections**—incomplete reports will be sent back for more information.
+
+  - type: checkboxes
+    id: confirmations
+    attributes:
+      label: "Before submitting"
+      options:
+        - label: "I'm using the **latest released** version of the library"
+          required: true
+        - label: "I've searched [open issues](issues?q=is%3Aissue%20state%3Aopen%20type%3ABug) and found no duplicate"
+          required: true
+
   - type: textarea
+    id: description
     attributes:
-      label: Issue Description
-      description: Provide a clear and detailed description of the issue you encountered and what you expected to happen instead.
-      placeholder: |
-        What happened?
-        What did you expect to happen?
+      label: "Describe the bug, tell us what went wrong"
+      placeholder: "A clear and concise description of what went wrong. What did you expect to happen vs. what actually happened."
     validations:
       required: true
 
   - type: textarea
+    id: reproduction
     attributes:
-      label: Reproduction Steps
-      description: Help us understand the issue by providing detailed steps to reproduce it. Include code examples, error messages, or configuration files if relevant.
+      label: "Reproduction snippet"
+      description: "How can we reproduce the bug?"
       placeholder: |
-        1. Install package with '...'
-        2. Configure pipeline with '...'
-        3. Run the following code '...'
-        4. Error occurs
+        Provide the cli command that reproduces the bug:
+        ```bash
+        # paste command here
+        ```
+        or the smallest possible script that reproduces the bug:
+        ```python
+        # paste code here
+        ```
+    validations:
+      required: false
+
+  - type: input
+    id: lib_version
+    attributes:
+      label: "Library version"
+      placeholder: "e.g. 1.4.2"
     validations:
       required: true
 
+  - type: input
+    id: python_version
+    attributes:
+      label: "Python version"
+      placeholder: "e.g. 3.12.0"
+    validations:
+      required: true
+
+  - type: input
+    id: os
+    attributes:
+      label: "Operating system"
+      placeholder: "e.g. Ubuntu 22.04 LTS / MacOS 14.3"
+    validations:
+      required: false
+
   - type: textarea
+    id: logs
     attributes:
-      label: Environment Details
-      description: Please provide information about your setup. This helps us identify if the issue is environment-specific.
-      placeholder: |
-        - Python Version: 
-        - Pipelex Version:
-        - Operating System:
-        - Installation Method (pip/poetry/uv):
-        - Relevant Dependencies:
+      label: "Stack trace / error output"
+      description: "Paste any relevant logs here."
+      render: shell
+    validations:
+      required: false
 
   - type: textarea
+    id: extra
     attributes:
-      label: Additional Context
-      description: Add any other relevant information, screenshots, logs, or context that might help us understand and fix the issue.
-      placeholder: |
-        Error logs, related configuration, or other helpful details...
+      label: "Additional context & screenshots"
+      placeholder: "Anything else that might help us debug."
+    validations:
+      required: false
 
   - type: dropdown
     id: contribution
@@ -53,13 +97,3 @@ body:
         - "Yes, I'd like to contribute"
     validations:
       required: true
-
-  - type: checkboxes
-    attributes:
-      label: Confirmations
-      description: Please confirm the following
-      options:
-        - label: I have checked that this issue hasn't already been reported
-          required: true
-        - label: I have tested with the latest version of Pipelex
-          required: true 

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,62 +1,56 @@
-name: 💡 Feature Request
-description: Suggest a new feature or improvement
-title: "feat: "
-labels: ["enhancement"]
+name: "✨ Feature request"
+description: "Suggest an idea or improvement for the library"
+type: Feature
+labels:
+  - status:needs-triage
+
 body:
-  - type: textarea
+  - type: markdown
     attributes:
-      label: Problem Statement
-      description: Describe the problem you're trying to solve or the limitation you're facing.
-      placeholder: |
-        What's the challenge you're encountering?
-        Why is this important to address?
-    validations:
-      required: true
+      value: |
+        **Thanks for contributing an idea!**
+        Please fill in the sections below so we can understand and prioritise your request.
+
+  - type: checkboxes
+    id: confirmations
+    attributes:
+      label: "Before submitting"
+      options:
+        - label: "I've searched [open issues](issues?q=is%3Aissue%20state%3Aopen%20type%3AFeature) and found no similar request"
+          required: true
+        - label: "I'm willing to start a discussion or contribute code"
+          required: false
 
   - type: textarea
+    id: problem
     attributes:
-      label: Proposed Solution
-      description: Describe your ideal solution to the problem. Be as specific as possible.
-      placeholder: |
-        How would you like this to work?
-        What would the user experience be like?
+      label: "Problem / motivation"
+      placeholder: "What problem does this feature solve? Who is affected and why?"
     validations:
       required: true
 
   - type: textarea
+    id: proposal
     attributes:
-      label: Alternative Approaches
-      description: Describe any alternative solutions or features you've considered.
-      placeholder: |
-        What other ways might this problem be solved?
-        What are the trade-offs of different approaches?
+      label: "Proposed solution"
+      placeholder: "Describe the feature you’d like to see."
+    validations:
+      required: false
 
   - type: textarea
+    id: alternatives
     attributes:
-      label: Implementation Ideas
-      description: If you have any thoughts on how this could be implemented, share them here.
-      placeholder: |
-        Technical considerations
-        Potential challenges
-        Integration points
+      label: "Alternatives considered"
+      placeholder: "Any work-arounds you’ve tried or other approaches you considered."
+    validations:
+      required: false
 
   - type: dropdown
     id: contribution
     attributes:
       label: Would you like to help implement this feature?
-      description: We welcome contributions and can provide guidance!
       options:
         - "Not at this time"
         - "Yes, I'd like to contribute"
     validations:
-      required: true
-
-  - type: checkboxes
-    attributes:
-      label: Confirmations
-      description: Please confirm the following
-      options:
-        - label: I have searched for similar feature requests
-          required: true
-        - label: This feature would benefit the broader community
-          required: true 
+      required: false