]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Modernize Gitlab Bug template
authorPetr Špaček <pspacek@isc.org>
Tue, 5 Dec 2023 17:29:37 +0000 (18:29 +0100)
committerPetr Špaček <pspacek@isc.org>
Wed, 13 Dec 2023 16:09:05 +0000 (17:09 +0100)
.gitlab/issue_templates/Bug.md

index f8b82b694b7e08ddc306db5e41449f860ada92bf..60bab3f6ce9b8a1fb9108568da28dbb58436ec11 100644 (file)
@@ -2,45 +2,62 @@
 If the bug you are reporting is potentially security-related - for example,
 if it involves an assertion failure or other crash in `named` that can be
 triggered repeatedly - then please make sure that you make the new issue
-confidential!
+confidential by clicking the checkbox at the bottom!
 -->
 
 ### Summary
 
-(Summarize the bug encountered concisely.)
+<!-- Concisely summarize the bug encountered. -->
 
-### BIND version used
+### BIND version affected
+<!--
+Make sure you are testing with the **latest** supported version of BIND
+for a given branch. Many bugs have been fixed over time!
+
+See https://kb.isc.org/docs/supported-platforms for the current list.
+The latest source is available from https://www.isc.org/download/#BIND
 
-(Paste the output of `named -V`.)
+Paste the output of `named -V` here.
+-->
 
 ### Steps to reproduce
 
-(How one can reproduce the issue - this is very important.)
+<!--
+This is extremely important! Be precise and use itemized lists, please.
+
+Even if a default configuration is affected, please include the full configuration
+files _you were testing with_.
+
+Example:
+1. Use _attached_ configuration file
+2. Start BIND server with command: `named -g -c named.conf ...`
+3. Simulate legitimate clients using command `dnsperf -S1 -d legit-queries ...`
+4. Simulate attack traffic using command `dnsperf -S1 -d attack-queries ...`
+-->
+
+1.
+2.
+3.
 
 ### What is the current *bug* behavior?
 
-(What actually happens.)
+<!-- What actually happens. -->
 
 ### What is the expected *correct* behavior?
 
-(What you should see instead.)
+<!-- What you should see instead. -->
 
 ### Relevant configuration files
 
-(Paste any relevant configuration files - please use code blocks (```)
+<!-- Paste any relevant configuration files here - please use code blocks (```)
 to format console output. If submitting the contents of your
-configuration file in a non-confidential Issue, it is advisable to
-obscure key secrets: this can be done automatically by using
-`named-checkconf -px`.)
-
-### Relevant logs and/or screenshots
-
-(Paste any relevant logs - please use code blocks (```) to format console
-output, logs, and code, as it's very hard to read otherwise.)
+configuration file in a non-confidential issue, it is advisable to
+obscure key secrets; this can be done automatically by using
+`named-checkconf -px`. -->
 
-### Possible fixes
+### Relevant logs
 
-(If you can, link to the line of code that might be responsible for the
-problem.)
+<!-- Paste any relevant logs here - please use code blocks (```) to format console
+output, logs, and code, as it's very hard to read otherwise. -->
 
-/label ~bug
+/label ~Bug