Update issue templates
authorHenning Westerholt <henningw@users.noreply.github.com>
Thu, 27 Sep 2018 13:14:50 +0000 (15:14 +0200)
committerHenning Westerholt <henningw@users.noreply.github.com>
Thu, 27 Sep 2018 13:14:50 +0000 (15:14 +0200)
.github/ISSUE_TEMPLATE/bug_report.md [moved from .github/ISSUE_TEMPLATE/custom.md with 85% similarity]
.github/ISSUE_TEMPLATE/feature_request.md [new file with mode: 0644]

similarity index 85%
rename from .github/ISSUE_TEMPLATE/custom.md
rename to .github/ISSUE_TEMPLATE/bug_report.md
index 83993d3..8132d74 100644 (file)
@@ -1,27 +1,21 @@
 ---
-name: Custom issue template
-about: Kamailio issue template
+name: Bug report
+about: Create a report to help us improve
 
 ---
 
 <!--
-Kamailio Project uses GitHub Issues only for bugs in the code or feature requests.
+Kamailio Project uses GitHub Issues only for bugs in the code or feature requests. Please use this template only for bug reports.
 
-If you have questions about using Kamailio or related to its configuration file,
-ask on sr-users mailing list:
+If you have questions about using Kamailio or related to its configuration file, ask on sr-users mailing list:
 
   * http://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users
 
-If you have questions about developing extensions to Kamailio or its existing
-C code, ask on sr-dev mailing list
+If you have questions about developing extensions to Kamailio or its existing C code, ask on sr-dev mailing list:
 
   * http://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev
 
-Please try to fill this template as much as possible for any issue. It helps the
-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.
+Please try to fill this template as much as possible for any issue. It helps the developers to troubleshoot the issue.
 
 If there is no content to be filled in a section, the entire section can be removed.
 
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644 (file)
index 0000000..539addd
--- /dev/null
@@ -0,0 +1,88 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+<!--
+Kamailio Project uses GitHub Issues only for bugs in the code or feature requests. Please use this template only for feature requests.
+
+If you have questions about using Kamailio or related to its configuration file, ask on sr-users mailing list:
+
+  * http://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users
+
+If you have questions about developing extensions to Kamailio or its existing C code, ask on sr-dev mailing list:
+
+  * http://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev
+
+Please try to fill this template as much as possible for any issue. It helps the developers to troubleshoot the issue.
+
+If you submit a feature request (or enhancement) 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).
+-->
+
+### Description
+
+<!--
+Explain what you did, what you expected to happen, and what actually happened.
+-->
+
+### Expected behavior
+
+#### Actual observed behavior
+
+#### Debugging Data
+
+```
+(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
+
+<!--
+If you found a solution or workaround for the issue, describe it. Ideally, provide a pull request with a improvement.
+-->
+
+### Additional Information
+
+  * **Kamailio Version** - output of `kamailio -v`
+
+```
+(paste your output here)
+```
+
+* **Operating System**:
+
+<!--
+Details about the operating system, the type: Linux (e.g.,: Debian 8.4, Ubuntu 16.04, CentOS 7.1, ...), MacOS, xBSD, Solaris, ...;
+Kernel details (output of `uname -a`)
+-->
+
+```
+(paste your output here)
+```