core: github issue template - sections for log messages and sip traffic
authorDaniel-Constantin Mierla <miconda@gmail.com>
Mon, 16 Jan 2017 15:34:54 +0000 (16:34 +0100)
committerDaniel-Constantin Mierla <miconda@gmail.com>
Mon, 16 Jan 2017 15:34:54 +0000 (16:34 +0100)
.github/ISSUE_TEMPLATE.md

index bd6b5e0..4b2019e 100644 (file)
@@ -17,6 +17,8 @@ developers to troubleshoot the issue.
 If you submit a feature request (or enhancement), you can delete the text of
 the template and only add the description of what you would like to be added.
 
+If there is no content to be filled in a section, the entire section can be removed.
+
 You can delete the comments from the template sections when filling.
 
 You can delete next line and everything above before submitting (it is a comment).
@@ -30,14 +32,15 @@ Explain what you did, what you expected to happen, and what actually happened.
 
 ### Troubleshooting
 
-<!--
-
 #### Reproduction
 
+<!--
 If the issue can be reproduced, describe how it can be done.
+-->
 
-#### Backtrace
+#### Debugging Data
 
+<!--
 If you got a core dump, use gdb to extract troubleshooting data - full backtrace,
 local variables and the list of the code at the issue location.
 
@@ -46,10 +49,34 @@ local variables and the list of the code at the issue location.
   info locals
   list
 
-If you are familiar with gdb, feel free to attach more of what you condier to
+If you are familiar with gdb, feel free to attach more of what you consider to
 be relevant.
 -->
 
+```
+(paste your debugging data here)
+```
+
+#### Log Messages
+
+<!--
+Check the syslog file and if there are relevant log messages printed by Kamailio, add them next, or attach to issue, or provide a link to download them (e.g., to a pastebin site).
+-->
+
+```
+(paste your log messages here)
+```
+
+#### SIP Traffic
+
+<!--
+If the issue is exposed by processing specific SIP messages, grab them with ngrep or save in a pcap file, then add them next, or attach to issue, or provide a link to download them (e.g., to a pastebin site).
+-->
+
+```
+(paste your sip traffic here)
+```
+
 ### Possible Solutions
 
 <!--