From 868fd431080e41daf76fb020af5d15aa074bbb8e Mon Sep 17 00:00:00 2001 From: Alessandro Ros Date: Sun, 21 Sep 2025 16:33:57 +0200 Subject: [PATCH] update issue / discussion templates (#5006) --- .github/DISCUSSION_TEMPLATE/questions.yml | 19 +++++++++---------- .github/ISSUE_TEMPLATE/bug.yml | 22 +++++++++++++++++++--- 2 files changed, 28 insertions(+), 13 deletions(-) diff --git a/.github/DISCUSSION_TEMPLATE/questions.yml b/.github/DISCUSSION_TEMPLATE/questions.yml index efddde7a..48d47f33 100644 --- a/.github/DISCUSSION_TEMPLATE/questions.yml +++ b/.github/DISCUSSION_TEMPLATE/questions.yml @@ -2,19 +2,18 @@ body: - type: markdown attributes: value: | - Please create a discussion FOR EACH question. Do not ask for multiple questions all at once, otherwise they'll probably never get all answered. + * Please create a discussion FOR EACH question. Do not ask for multiple questions all at once, otherwise they'll probably never get all answered. + * If you are asking for help because you're having trouble doing something, provide enough informations to replicate the problem. In particular, include in the question: + + * MediaMTX version + * precise instructions on how to replicate the problem + * MediaMTX configuration + * MediaMTX logs with setting `logLevel` set to `debug` + + * If you are asking for help and you think MediaMTX is misbehaving, open a bug report, NOT a discussion. - type: textarea attributes: label: Question validations: required: true - - - type: markdown - attributes: - value: | - Note: If you are asking for help because you're having trouble doing something, provide enough informations to replicate the problem. In particular, include in the question: - - * the server version you are using - * precise instructions on how to replicate the problem - * server logs with setting `logLevel` set to `debug` diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index fb703c21..c006ba94 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -39,23 +39,39 @@ body: - type: textarea id: description + attributes: + label: Describe the issue + validations: + required: true + + - type: textarea + id: replica attributes: label: Describe how to replicate the issue description: | The maintainers must be able to REPLICATE your issue to solve it - therefore, describe in a very detailed way how to replicate it. value: | - 1. start the server + 1. start the MediaMTX 2. publish with ... 3. read with ... validations: required: true + - type: textarea + id: conf + attributes: + label: MediaMTX configuration + description: | + MediaMTX configuration is often required to replicate the issue. + placeholder: Paste or drag the configuration file here + # render: shell + - type: textarea id: logs attributes: - label: Server logs + label: MediaMTX logs description: | - Server logs are sometimes useful to identify the issue. If you think this is the case, set the parameter 'logLevel' to 'debug' and attach the server logs. + MediaMTX logs are often useful to identify the issue. If you think this is the case, set the parameter 'logLevel' to 'debug' and attach logs. placeholder: Paste or drag the log file here # render: shell