Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestions for support requests and bug reports #4484

Closed
clampak opened this issue Dec 15, 2014 · 1 comment
Closed

Suggestions for support requests and bug reports #4484

clampak opened this issue Dec 15, 2014 · 1 comment

Comments

@clampak
Copy link

@clampak clampak commented Dec 15, 2014

In the interest of improving bug reports / support requests, I have a few suggestions.

  1. Change the direct link to https://github.com/rg3/youtube-dl/issues/new underlying the support button on the yt-dl.org webpage. A better option might be to have it point to https://github.com/rg3/youtube-dl/blob/master/README.md#bugs, or https://github.com/rg3/youtube-dl/blob/master/CONTRIBUTING.md. At the very least, change it to https://github.com/rg3/youtube-dl/issues so that people would be slightly more likely to search around first.
  2. Change the http://yt-dl.org/bug pointer to the same link as the one above.
  3. Rearrange the output wording when youtube-dl encounters an error, so that the URL for reporting bugs is after a suggestion and instructions (or link) to update youtube-dl. Suggestion: "Please make sure your youtube-dl version is up to date; see https://yt-dl.org/update on how to update. If you are using the most current version, you may report this issue by calling youtube-dl with the --verbose flag and following instructions on https://yt-dl.org/bug."
  4. Somewhere close to the top of the top of the BUGS portion of the README could be a link to stackoverflow, e.g. http://stackoverflow.com/questions/tagged/youtube-dl, with a suggestion that any requests solely about usage go there, and post on github later on if there is no response. I've noticed that @phihag monitors stackoverflow, and it's clear other users do as well and are more than happy to pitch in. There aren't a heck of a lot of questions there right now (<100), but virtually all of them have been answered.
  5. Somewhat related, remove the '#' symbol from the output when downloading multiple videos. This would prevent the references to whatever issue it corresponds with on github. It's clear enough without it.
    compare: [download] Downloading video #13 of 26,
    and [download] Downloading video 13 of 26
  6. If there is a way to make the "Please review the guidelines for contributing to this repository." note about 3 times larger on the new issues page, that might be helpful. Or add a few short lines to it, such as "1) Is your youtube-dl version current? Most recent version is <version>. 2) Are you including the complete output using the --verbose flag?" Alternatively, is there a way to make a stackexchange-like automatic search for issues as you write them, or before you submit?

I really appreciate all the work you've all put into this great program. Hope this helps.

phihag added a commit that referenced this issue Dec 15, 2014
phihag added a commit that referenced this issue Dec 15, 2014
@phihag
Copy link
Contributor

@phihag phihag commented Dec 15, 2014

  1. Done in a29e9ec
  2. It already points there.
  3. I'd rather check for the version automatically, and customize the output on that. Patches welcome, but I'll get to it one day.
  4. I love stackoverflow, but I think many issues could be much better handled in this issue tracker. Note that many answers on stackoverflow are flat-out wrong or at least quite questionable. Also, stackoverflow questions often get closed when they're overly youtube-dl-specific.
    And although I do monitor stackoverflow questions about youtube-dl, this issue tracker is a much better place. I do not want people to post bug reports to stackoverflow.
  5. The proper format is of course to enclose the output in
    ```
    ; thus preventing all markdown rendering. Nevertheless, I've dropped the hash character in 734ea11 .
  6. That note is generated by GitHub, I don't think we can change it in any way.

Thank you very much for the great suggestions!

@phihag phihag closed this Dec 15, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.