From 5a9c769f5cd413eb4f92d4e2d91ed9d3067456fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=A0ar=C5=ABnas=20Nejus?= Date: Sat, 1 Feb 2025 15:59:20 +0000 Subject: [PATCH] Link to specific bug report/feature request templates in docs --- docs/faq.rst | 18 ++++++++++-------- docs/guides/tagger.rst | 3 ++- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index b740c6503..ac7818ab2 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -174,9 +174,8 @@ pages. …report a bug in beets? ----------------------- -We use the `issue tracker `__ -on GitHub. `Enter a new issue `__ -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 `__. 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 `__ and we'll look into -it. There's always a possibility that there's a bug "upstream" in the -`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 `__ +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 diff --git a/docs/guides/tagger.rst b/docs/guides/tagger.rst index 68ad908e8..bf1ecbd8a 100644 --- a/docs/guides/tagger.rst +++ b/docs/guides/tagger.rst @@ -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.