Populate bug issue template automatically (#5612)

Update documentation to use specific GitHub issue templates instead of
generic issue links. This helps users provide better structured feedback
when reporting bugs or requesting features.

This was noted in
https://github.com/beetbox/beets/issues/5610#issuecomment-2628985640
This commit is contained in:
Šarūnas Nejus 2025-02-17 00:29:26 +00:00 committed by GitHub
commit 4e7b054f48
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 12 additions and 9 deletions

View file

@ -174,9 +174,8 @@ pages.
…report a bug in beets?
-----------------------
We use the `issue tracker <https://github.com/beetbox/beets/issues>`__
on GitHub. `Enter a new issue <https://github.com/beetbox/beets/issues/new>`__
there to report a bug. Please follow these guidelines when reporting an issue:
We use the `issue tracker`_ on GitHub where you can `open a new ticket`_.
Please follow these guidelines when reporting an issue:
- Most importantly: if beets is crashing, please `include the
traceback <https://imgur.com/jacoj>`__. Tracebacks can be more
@ -206,6 +205,7 @@ If you've never reported a bug before, Mozilla has some well-written
`general guidelines for good bug
reports`_.
.. _issue tracker: https://github.com/beetbox/beets/issues
.. _general guidelines for good bug reports: https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines
@ -343,11 +343,11 @@ read the file. You can also use specialized programs for checking file
integrity---for example, type ``metaflac --list music.flac`` to check
FLAC files.
If beets still complains about a file that seems to be valid, `file a
bug <https://github.com/beetbox/beets/issues/new>`__ and we'll look into
it. There's always a possibility that there's a bug "upstream" in the
`Mutagen <https://github.com/quodlibet/mutagen>`__ library used by beets,
in which case we'll forward the bug to that project's tracker.
If beets still complains about a file that seems to be valid, `open a new
ticket`_ and we'll look into it. There's always a possibility that there's
a bug "upstream" in the `Mutagen <https://github.com/quodlibet/mutagen>`__
library used by beets, in which case we'll forward the bug to that project's
tracker.
.. _importhang:
@ -398,3 +398,5 @@ try `this Super User answer`_.
.. _this Super User answer: https://superuser.com/a/284361/4569
.. _pip: https://pip.pypa.io/en/stable/
.. _open a new ticket:
https://github.com/beetbox/beets/issues/new?template=bug-report.md

View file

@ -76,7 +76,8 @@ all of these limitations.
Musepack, Windows Media, Opus, and AIFF files are supported. (Do you use
some other format? Please `file a feature request`_!)
.. _file a feature request: https://github.com/beetbox/beets/issues/new
.. _file a feature request:
https://github.com/beetbox/beets/issues/new?template=feature-request.md
Now that that's out of the way, let's tag some music.