bug_report.yml

name: Bug report
description: Something is broken or behaving unexpectedly.
title: "bug: <one-line summary>"
labels: ["bug", "triage"]

body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to file a bug report. Please fill in as much
        of the form as you can — the more we know, the faster we can fix it.

        Before submitting:
        - Search [existing issues](https://github.com/GrayCodeAI/hawk-sdk-python/issues) to avoid duplicates.
        - If this is a security issue, please **do not** file a public issue. See `SECURITY.md`.

  - type: textarea
    id: what-happened
    attributes:
      label: What happened?
      description: A clear, concise description of the bug.
      placeholder: When I call HawkClient.<method>, I expected X but got Y.
    validations:
      required: true

  - type: dropdown
    id: surface
    attributes:
      label: Surface
      description: Which SDK surface is affected?
      options:
        - "HawkClient (sync)"
        - "AsyncHawkClient (async)"
        - "Streaming (chat_stream / StreamReader)"
        - "Retry / backoff"
        - "Tools (chat_with_tools, @tool decorator)"
        - "Agent / AsyncAgent"
        - "Workflow / AsyncWorkflow"
        - "Typed errors (HawkAPIError hierarchy)"
        - "Build / packaging"
    validations:
      required: true

  - type: textarea
    id: reproduce
    attributes:
      label: Steps to reproduce
      description: Minimal Python snippet that reliably reproduces the problem.
      render: python
      placeholder: |
        from hawk import HawkClient
        with HawkClient() as c:
            resp = c.chat("hello")
        # ^ wrong shape / panic / hang / etc.
    validations:
      required: true

  - type: textarea
    id: expected
    attributes:
      label: Expected behavior
      description: What did you expect to happen instead?
    validations:
      required: true

  - type: input
    id: sdk-version
    attributes:
      label: hawk-sdk version
      description: Output of `python -c "import hawk; print(hawk.__version__)"`.
      placeholder: "0.2.0"
    validations:
      required: true

  - type: input
    id: daemon-version
    attributes:
      label: hawk daemon version
      description: Output of `hawk version` (the daemon you're hitting).
      placeholder: "0.2.0"
    validations:
      required: true

  - type: input
    id: python-version
    attributes:
      label: Python version
      description: Output of `python --version`.
      placeholder: "Python 3.11.9"
    validations:
      required: true

  - type: input
    id: os
    attributes:
      label: Operating system
      description: e.g. macOS 14.5 (arm64), Ubuntu 24.04 (amd64), Windows 11 (amd64).
      placeholder: "macOS 14.5 (arm64)"
    validations:
      required: true

  - type: textarea
    id: deps
    attributes:
      label: Relevant package versions
      description: |
        Paste the output of `pip freeze | grep -E "^(httpx|pydantic|hawk-sdk)"` (or `uv pip list` equivalent).
      render: shell

  - type: textarea
    id: logs
    attributes:
      label: Logs / traceback
      description: |
        Paste any relevant output, including the full traceback.
        **Redact API tokens, session IDs, and any private data first.**
      render: shell

  - type: checkboxes
    id: confirm
    attributes:
      label: Confirmation
      options:
        - label: I searched existing issues and did not find a duplicate.
          required: true
        - label: I redacted any secrets, tokens, or private data from logs.
          required: true