Feedback on "Before posting in the issue tracker"

[zanieb]

Hey! We're giving https://github.com/astral-sh/uv/issues/9452 a try to help guide people towards common issues and set expectations for interactions in the issue tracker.

That issue is locked to avoid distracting commentary, but feedback is very welcome!

[cthoyt]

Minor typo in <details> bock that should be <details> block

You might want to mention not to take screenshots and that copy/pasting out of the terminal is more helpful. I manage a ML library where people send screenshots and it's no fun at all 😓

[zanieb]

Thanks @cthoyt! I fixed that, and I'll expand the note on screenshots.

[zanieb]

Note to self, we should also cover "Confirming that an issue is a problem with uv" by suggesting

• python -m build for build failures
• python -m pip install --use-pep517 --no-cache --force-reinstall for install failures

[FishAlchemist]

Although it might not be directly related to this issue, have you considered mentioning #9452 in the issue template? For example, like this:

• [x] I have read #9452
• [x] What uv version is being used?
• [x] Can issue be reproduced in the latest uv version?
• [x] What is the operating system?
• [x] What command did you run?
• [x] What is the output of the command with the --verbose flag?
• [x] Is there a minimal reproduction of the problem?

[FishAlchemist]

UV has auto-completion, so is it necessary to mention the text editor being used?

[drmikehenry]

(Minor) There's a double "and" in the phrase help diagnose your issue and and in #9452.

[zanieb]

(Minor) There's a double "and" in the phrase help diagnose your issue and and in #9452.

Thank you! Fixed.

[weihenglim]

A helpful tip that we can include is to add the sort:relevance qualifier when searching for existing issues. This drastically improves the search results in my experience.

[FishAlchemist]

Are we possible to prevent using echo to print environment variables? Because echo can print both environment variables and shell variables in the same way, as shown in the figure below. I suggest using printenv instead of echo to display environment variables. https://www.man7.org/linux/man-pages/man1/printenv.1.html

[rsyring]

Turn on GH Discussions to differentiate discussions from true issues. refs: https://github.com/astral-sh/uv/issues/11685