Skip to content

Arachne Issue Template (Generic)

Owner: GhostWeasel (Lead: doubletap-dave)

Audience: Users and contributors

Purpose: Provide a concise, privacy‑first structure for reporting any issue (bug, question, usability concern, docs gap, etc.)

1) Issue Type

  • Bug
  • Question
  • Feature request
  • Documentation
  • Performance
  • Usability / DX
  • Other (describe below)

2) Summary

3) Environment

  • OS: (e.g., macOS 14.5 / Ubuntu 22.04 / Windows 11)
  • Python: 3.11.x
  • Arachne version: x.y.z
  • Tooling (if relevant): uv version, ruff/mypy/pytest versions
  • Installation method: (e.g., pip/uv/local build)

4) Reproduction / Context

  • Steps to reproduce: 1. 2. 3.
  • Minimal repro snippet (sanitized; schemas or field names only, no real data):
  • Node/edge definitions, bounds, overflow policy (block/drop/latest/coalesce)
  • Any relevant lifecycle hooks (on_start/on_message/on_tick/on_stop)

5) Observed vs Expected

  • Observed:
  • What happened, including any redacted stack traces or error summaries.
  • Example structured logs (redact values; keep keys):
    • event="edge_overflow", edge_id="EDGE_A", policy="drop", dropped=123
    • event="node_error", node_id="NODE_X", error_type="ValueError", message=""
  • Expected:
  • What you expected to happen instead.

6) Additional Details (Optional)

  • Metrics snapshot (counters/gauges; avoid PII in labels):
  • queue_depth_example=, overflow_count_example=
  • Config highlights (redacted):
  • Relevant keys and enum/boolean values only. Replace secrets with or CHECKSUM(...).
  • Frequency/timing:
  • Intermittent/consistent; started after .
  • Workarounds tried:
  • What you attempted and results.

7) Impact

8) Attachments (Optional)

9) Proposed Next Steps (Optional)

Checklist

  • I removed payload contents, secrets, tokens, PII, and proprietary identifiers.
  • I provided a minimal reproduction or the smallest set of redacted artifacts possible.
  • I included OS/Python/Arachne versions and relevant tooling info.
  • I clearly described observed vs expected behavior.

References

  • Troubleshooting: docs/support/TROUBLESHOOTING.md
  • How to Report Issues: docs/support/HOW-TO-REPORT-ISSUES.md
  • Governance and Overview (M0): docs/plan/M0-governance-and-overview.md
  • Contributing Guide: docs/contributing/CONTRIBUTING.md