Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.64 KB

File metadata and controls

37 lines (28 loc) · 1.64 KB

Getting help

Open an issue in the repository you are using. Questions are as welcome as bug reports — if something was hard to figure out, that is usually a gap in the documentation, and saying so helps.

Before opening an issue, a quick look at the repository README and its existing issues often saves you the wait — but if you have looked and are still stuck, open one anyway.

What makes an issue easy to answer

Roughly, in order of usefulness: the exact commands you ran, the full error message rather than a summary of it, your OS and Python version, and the package version (pip show <package>). If you can reduce the problem to a short script, that usually turns a long thread into a short one.

Response times

One maintainer, working on this alongside research. Expect days rather than hours, and longer during teaching terms and conference season. Nothing is ignored; some things are just slow.

Other things

  • Security problems — please do not use the public tracker. See SECURITY.md.
  • Contributing a fix — see the CONTRIBUTING.md in the repository you are working on.
  • Citing this software in a paper — see the CITATION.cff file or the Citation section of the README.