Skip to content

Commit 4e7b054

Browse files
authored
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 #5610 (comment)
2 parents 810af1f + 5a9c769 commit 4e7b054

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

docs/faq.rst

+10-8
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,8 @@ pages.
174174
…report a bug in beets?
175175
-----------------------
176176

177-
We use the `issue tracker <https://github.com/beetbox/beets/issues>`__
178-
on GitHub. `Enter a new issue <https://github.com/beetbox/beets/issues/new>`__
179-
there to report a bug. Please follow these guidelines when reporting an issue:
177+
We use the `issue tracker`_ on GitHub where you can `open a new ticket`_.
178+
Please follow these guidelines when reporting an issue:
180179

181180
- Most importantly: if beets is crashing, please `include the
182181
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
206205
`general guidelines for good bug
207206
reports`_.
208207

208+
.. _issue tracker: https://github.com/beetbox/beets/issues
209209
.. _general guidelines for good bug reports: https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines
210210

211211

@@ -343,11 +343,11 @@ read the file. You can also use specialized programs for checking file
343343
integrity---for example, type ``metaflac --list music.flac`` to check
344344
FLAC files.
345345

346-
If beets still complains about a file that seems to be valid, `file a
347-
bug <https://github.com/beetbox/beets/issues/new>`__ and we'll look into
348-
it. There's always a possibility that there's a bug "upstream" in the
349-
`Mutagen <https://github.com/quodlibet/mutagen>`__ library used by beets,
350-
in which case we'll forward the bug to that project's tracker.
346+
If beets still complains about a file that seems to be valid, `open a new
347+
ticket`_ and we'll look into it. There's always a possibility that there's
348+
a bug "upstream" in the `Mutagen <https://github.com/quodlibet/mutagen>`__
349+
library used by beets, in which case we'll forward the bug to that project's
350+
tracker.
351351

352352

353353
.. _importhang:
@@ -398,3 +398,5 @@ try `this Super User answer`_.
398398

399399
.. _this Super User answer: https://superuser.com/a/284361/4569
400400
.. _pip: https://pip.pypa.io/en/stable/
401+
.. _open a new ticket:
402+
https://github.com/beetbox/beets/issues/new?template=bug-report.md

docs/guides/tagger.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ all of these limitations.
7676
Musepack, Windows Media, Opus, and AIFF files are supported. (Do you use
7777
some other format? Please `file a feature request`_!)
7878

79-
.. _file a feature request: https://github.com/beetbox/beets/issues/new
79+
.. _file a feature request:
80+
https://github.com/beetbox/beets/issues/new?template=feature-request.md
8081

8182
Now that that's out of the way, let's tag some music.
8283

0 commit comments

Comments
 (0)