How to ask a good question

[yreyricord]

A well-posed question gets answered fast. This short guide helps you
write one.

The four ingredients of a good question

1. What you are trying to do, in one sentence.
2. What you tried, with the exact commands or code snippet.
3. What you observed, with the full error message or wrong output.
4. What you expected to see instead.

If any of the four is missing, expect a clarifying reply before any
real answer.

A reproducible example beats a paragraph

If your question involves code, paste a minimal, self-contained snippet
the reader can run as is. Strip everything that is not strictly required
to reproduce the issue. Use a fenced code block with the language tag:

```python
from bps_common import some_function
result = some_function(input_data="...")
print(result)
```

For long logs or stack traces, use a collapsible block:

```markdown

Full traceback

```
paste here
```

\`\`\`

Include your context

• BPS version: output of git describe --tags --always or the
  release tag.
• Python version: python --version.
• Operating system: macOS 14, Ubuntu 22.04, Windows 11, etc.
• Installation method: pip, conda, Docker image, source build.

Search before posting

Before opening a new question, search:

• Open Q&A
• Closed issues
• Documentation

Chances are someone already asked the same thing.

When your question becomes an issue

If your question reveals a real defect or a missing feature, a maintainer
will ask you to file an issue using one of the five templates (bug,
feature, algorithm, docs, security). Discussions are conversational;
issues are actionable.

Mark the answer

When a reply solves your problem, click Mark as answer on it. The
discussion is then highlighted with a green badge, and future readers
find the solution instantly.

What if no one replies?

Maintainers triage Discussions weekly. If your question gets no traction
after a week, bump it with a comment and tag a maintainer. Patience and
politeness help.

Thanks for taking the time to ask well.