Add a GitHub issue template for questions
authorDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Sat, 3 Aug 2019 11:30:47 +0000 (13:30 +0200)
committerDr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
Wed, 30 Oct 2019 16:46:00 +0000 (17:46 +0100)
Actually, we would rather see general questions posted to the
openssl-users mailing list. But habits have changed and more and
more users ask questions on GitHub. Many of them are currently tagged
as bug reports or feature requests, because there is no appropriate
template for questions. This commit adds the missing template.

This template automatically adds the [issue: question] label.

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10051)

.github/ISSUE_TEMPLATE/bug_report.md
.github/ISSUE_TEMPLATE/feature_request.md
.github/ISSUE_TEMPLATE/question.md [new file with mode: 0644]

index 489e024..5e33c14 100644 (file)
@@ -6,7 +6,8 @@ about: Report a defect in the software
 ---
 
 <!--
-Thank you for your bug report.
+Thank you for your bug report. If this is your first one,
+please take the time to read the following lines before posting it.
 
 NOTE:
 
index 2af3131..706c022 100644 (file)
@@ -6,7 +6,8 @@ about: Propose a feature you would like to see added in the software
 ---
 
 <!--
-Thank you for your feature request.
+Thank you for your feature request. If this is your first one,
+please take the time to read the following lines before posting it.
 
 NOTE:
 
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644 (file)
index 0000000..513ad5b
--- /dev/null
@@ -0,0 +1,56 @@
+---
+name: Question
+labels: 'issue: question'
+about: Ask a question about OpenSSL
+---
+
+<!--
+Thank you for your interest in OpenSSL. If this is your first question,
+please take the time to read the following lines before posting it.
+
+For general questions about *using* OpenSSL:
+
+    If you have questions about how to use OpenSSL for specific tasks
+    or how to solve certain problems you have when using it, you might
+    want to ask them on the openssl-users@openssl.org mailing list.
+    There you can get help from a great community of OpenSSL users,
+    not only (but including) the OpenSSL developers. For more information
+    about our mailing lists, see
+    https://www.openssl.org/community/mailinglists.html.
+
+For questions related to build issues:
+
+    Please use the 'Bug report' template.
+
+For other questions:
+
+    Please describe your problem as concisely as possible while giving
+    us enough information to understand your problem. Example code
+    or example commands are highly appreciated if they help us to
+    better understand what you are trying to achieve.
+
+    Also, please remember to tell us which OpenSSL version you are
+    using and whether it is system provided or you built it yourself.
+    In the latter case, please also send us your build configuration.
+    With OpenSSL before 1.1.1, the configuration output comes from the
+    configuration command.  With OpenSSL 1.1.1 and on, you can obtain
+    the information by running the command `perl configdata.pm --dump`
+    in the root directory of the source tree.
+
+Please remember to put ``` lines before and after any commands plus
+output and code, like this:
+
+    ```
+    $ echo output output output
+    output output output
+    ```
+
+    ```
+    #include <stdio.h>
+
+    int main() {
+        int foo = 1;
+        printf("%d\n", foo);
+    }
+    ```
+-->