diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index e976dd5c9..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,30 +0,0 @@ - - - -- **OS and version used:** - -- **SDK version used:** - - -# Description of the issue: - - -# Code sample exhibiting the issue: - - -# Console log of the issue: - - - diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..1e643b1f0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,81 @@ +--- +name: Bug Report +about: Create a bug report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +------------------------------- delete below ------------------------------- + +INSTRUCTIONS +========== + +Please follow the instructions and template below to save us time requesting additional information from you. + +1. Search existing issues to avoid creating duplicates. + +2. If possible test using the latest release to make sure your issues has not already been fixed: +https://github.com/Azure/azure-iot-sdk-c/releases/latest + +3. Do not share information from your Azure subscription here (connection strings, service names (IoT Hub name, Device Provisioning Service scope ID), etc...). If you need to share any of this information, you can create a ticket and get assistance from the Microsoft Support. + +How to Submit an Azure Support Ticket: https://docs.microsoft.com/en-us/azure/azure-supportability/how-to-create-azure-support-request + + +4. Include enough information for us to address the bug: + + - A detailed description. + - A Minimal Complete Reproducible Example (https://stackoverflow.com/help/mcve). This is code we can cut and paste into a readily available sample and run, or a link to a project you've written that we can compile to reproduce the bug. + - Console logs. If you are unsure how to enable logging, refer to this document: https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/Iothub_sdk_options.md + +5. Delete these instructions before submitting the bug. + + + +Below is a hypothetical bug report. We recommend you use it as a template and replace the information below each header with your own. + +------------------------------- delete above ------------------------------- + + +**Development Machine, OS, Compiler (and Other Relevant Toolchain Info)** + +Raspberry Pi, Raspbian Stretch Lite (Release 2018-11-13) +Cross Compiled on Ubuntu 18.04 using GCC 6.3.0 + +**SDK Version (Please Give Commit SHA if Manually Compiling** + +Release 2019-01-31 + +**Protocol** + +MQTT + +**Describe the Bug** + +If MQTT is unable to establish a connection, it will keep trying and once it succeeds queued messages will be sent to the Cloud. However, if for some reason we can't get past the initial connection phase, then SDK does not respect message timeouts. + +**[MCVE](https://stackoverflow.com/help/mcve)** + +``` +#include "iothub.h" + +int main(void) +{ + if (lightbulb == ON) { + iothub_say_hello(); + return 0; + } else { + iothub_say_goodbye(); + return 1; + } +} +``` + +**Console Logs** + +Sending message 1 to IoTHub +-> 15:07:42 PUBLISH | IS_DUP: false | RETAIN: 0 | QOS: DELIVER_AT_LEAST_ONCE | TOPIC_NAME: devices/tracingDevice/messages/events/property_key=property_value | PACKET_ID: 93 | PAYLOAD_LEN: 12 +<- 15:07:42 PUBACK | PACKET_ID: 92 +Confirmation callback received for message 86 with result IOTHUB_CLIENT_CONFIRMATION_OK diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 000000000..4e16703e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,33 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +------------------------------- delete below ------------------------------- + +Thank you for submitting a feature request. A few things: + +- Please check that a similar feature request has not already been submitted. Adding support to a currently existing feature request by commenting will increase the visibility and importance of your request beyond submitting a duplicate request. + +- If this is a large feature request (i.e. if it requires changes across multiple language SDKs), please submit it to user voice. +https://feedback.azure.com/forums/321918-azure-iot + +As an open source project, we welcome PRs for new features, and we don't want to reject any hard work you've done to contribute. **So propose your solution through an issue first** so we can discuss the changes, and if things look good we will ask you submit a PR to implement the changes. + +------------------------------- delete above ------------------------------- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/technical-question.md b/.github/ISSUE_TEMPLATE/technical-question.md new file mode 100644 index 000000000..c2da20052 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/technical-question.md @@ -0,0 +1,20 @@ +--- +name: Technical Question +about: Ask a technical question related to the SDK +title: '' +labels: question +assignees: '' + +--- + +------------------------------- delete below ------------------------------- + +Thank you for asking a technical question! If your question is "why doesn't my code work?", please submit a Bug issue instead. + +We also encourage users to submit technical questions related to the SDK on Stack Overflow. + +For Stack Overflow, simply submit a question with the tag "azure-iot-hub". + +If your technical question requires submitting service logs, you can submit an Azure Support Ticket: https://docs.microsoft.com/en-us/azure/azure-supportability/how-to-create-azure-support-request + +------------------------------- delete above -------------------------------