feature_request.yml

name: Feature request
description: Suggest an improvement or a new SDK capability.
title: "feat: <one-line summary>"
labels: ["enhancement", "triage"]

body:
  - type: markdown
    attributes:
      value: |
        Thanks for proposing a feature. hawk-sdk is a thin Python client for
        the local hawk daemon. Every feature is evaluated against whether it
        serves **a single developer** running their own hawk daemon — i.e.
        it improves ergonomics, lowers latency, or simplifies integration.

        Before submitting:
        - Search [existing issues](https://github.com/GrayCodeAI/hawk-sdk-python/issues) to avoid duplicates.
        - For new daemon endpoints, the daemon side must land first.

  - type: dropdown
    id: kind
    attributes:
      label: Kind of feature
      description: What flavour of change is this?
      options:
        - "New client method (wraps a daemon endpoint)"
        - "Streaming / SSE handling"
        - "Retry / backoff / resilience"
        - "Typed errors / error categories"
        - "Tools (chat_with_tools, @tool decorator)"
        - "Agent / Workflow orchestration"
        - "Pydantic model / type-hint improvement"
        - "Configuration (httpx transport, timeouts, etc.)"
        - "Tooling / CI / docs / packaging"
    validations:
      required: true

  - type: textarea
    id: problem
    attributes:
      label: What problem are you trying to solve?
      description: Describe the user problem first. Solutions can come later.
      placeholder: When I call <method>, I have to write boilerplate Y because the SDK doesn't expose X.
    validations:
      required: true

  - type: textarea
    id: proposal
    attributes:
      label: Proposed solution
      description: How would you like the SDK to behave? Snippet of API you'd want.
      render: python
    validations:
      required: true

  - type: textarea
    id: alternatives
    attributes:
      label: Alternatives considered
      description: |
        What did you try? What do other SDKs (`openai-python`,
        `anthropic-sdk-python`, `langchain`, `llama-index`, `dspy`,
        `instructor`, `marvin`, `pydantic-ai`, `mirascope`, `magentic`)
        do? Why isn't that enough?

  - type: checkboxes
    id: principles
    attributes:
      label: Solo-developer fit
      description: hawk-sdk avoids enterprise scope. Confirm this feature respects that.
      options:
        - label: Works with zero configuration (sensible defaults).
        - label: Does not introduce a third-party network dependency.
        - label: Does not break wire-compatibility with existing daemon versions.
        - label: Sync and async variants are kept in lock-step.
        - label: Has an escape hatch (override via parameter, transport, or env).