Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 2.65 KB

SUPPORT.md

File metadata and controls

74 lines (50 loc) · 2.65 KB

Support

Welcome! This page is the fastest way to get help with apix with the least back-and-forth.

Choose the right place

You want to... Go to...
Ask a question / discuss design 💬 Discussions
Report a reproducible bug 🐞 Issues
Report a security issue (private) 🔒 Security
Read docs / guides 📚 README
Review recent changes 🧾 Commits

Before you post (2 minutes)

  • Search existing Issues/Discussions (duplicates slow everyone down).
  • Confirm you are on the latest commit of main (many bugs are already fixed).
  • Reduce to a minimal reproduction (small snippet or a tiny public repo).

Bug reports that get solved fast

When opening an Issue, please include:

  • What happened vs what you expected
  • Minimal repro: exact steps + code (or a small public repo)
  • Versions:
    • apix commit or tag
    • the module or package involved
  • Environment: OS + architecture (Linux x86_64, macOS arm64, Windows x86_64, etc.)
  • Output: exact error/logs (copy as text, not screenshots)
  • If relevant: feature flags and a backtrace

Helpful links:


Performance reports (we love them)

If you suspect a performance regression, please add:

  • a benchmark or minimal test case
  • input sizes / dataset shape
  • before vs after numbers
  • hardware, OS and build profile (release or debug)
  • profiling output if you have it (even a short summary)

Scope and expectations

We are happy to help with:

  • ✅ Reproducible bugs and regressions
  • ✅ Documentation gaps and examples
  • ✅ Clarifying intended behavior / API usage
  • ✅ Performance regressions (with a benchmark)

We usually cannot help with:

  • ❌ "It is broken" with no repro, versions, or logs
  • ❌ Debugging heavily modified forks (please reproduce on upstream)
  • ❌ Security reports via public Issues (use the Security Policy link)
  • ❌ Requests to run, host, or operate apix for you (this is a codebase, not a managed service)

apix is community-driven. There is no guaranteed SLA, but clear reports get the fastest response.

Thanks for helping keep the project sharp. 🧠