Merge pull request #120 from ARMmbed/issue-templates

Update issue templates

Author: Janne Kiiskilä

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is. Please note that issues with the network drivers and boards themselves should be reported to their respective repositories or [Mbed OS](https://github.com/ARMmbed/mbed-os/issues) repository.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. 
+2. 
+3. 
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+Add logs to help explain your problem. Information how to enable logs is available in [README.md](https://github.com/ARMmbed/mbed-os-example-pelion/blob/master/README.md#enabling-logs).
+
+**Host system (please complete the following information):**
+ - OS: [Windows x.y, Ubuntu x.y, ...]
+ - Compiler:
+ - Compiler version:
+ - Mbed CLI version (if used):
+
+**Device information:**
+ - Device: [e.g. K64F, Linux/x86, ...  ]
+ - OS: [e.g. Mbed OS 5.15.x]
+ - Client version: [e.g. 1.0.0]
+ - Other SW: [attach printout of `mbed ls`]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[REQ]"
+labels: enhancement
+assignees: ''
+
+---
+
+**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.
+Please bear in mind the target of this example - it is supposed to be a very short and simple demo applications, which highlights just the device connectivity and firmware update using the developer flow. With minimal resources and lines of code.
+
+Actual client features can be requested also via the [Pelion client repository](https://github.com/armmbed/mbed-cloud-client/issues).
+
+**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.

README.md

@@ -90,6 +90,32 @@ Check the public tutorial for further information:
 
   [https://www.pelion.com/docs/device-management/current/connecting/mbed-os.html](https://www.pelion.com/docs/device-management/current/connecting/mbed-os.html)
 
+## Enabling logs
+
+Logging (or tracing) can be enabled by modifying the [`mbed_app.json`](https://github.com/ARMmbed/mbed-os-example-pelion/blob/master/mbed_app.json#L19) file.
+
+    ```
+            "mbed-trace.enable"                         : null,
+    ```
+By modifying that `null` to `1` and recompiling the application.
+
+Log level can be modified compile-time by defining `MBED_TRACE_MAX_LEVEL` -macro to `mbed_app.json`:
+
+   ```
+    "target.macros_add": [
+         "MBED_TRACE_MAX_LEVEL=TRACE_LEVEL_INFO",
+   ```
+
+Default level is `TRACE_LEVEL_DEBUG`, possible values are:
+* `TRACE_LEVEL_DEBUG` (largest amounts of logs)
+* `TRACE_LEVEL_INFO`
+* `TRACE_LEVEL_WARN` and
+* `TRACE_LEVEL_ERROR` (smallest amount of logs).
+
+Component level run-time control is also possible by setting log levels (by calling `mbed_trace_config_set()`) and inclusions/exclusions (by calling `mbed_trace_include_filters_set()` or mbed_trace_exclude_filters_set()`).
+
+For more details, see the [`mbed-trace`](https://github.com/ARMmbed/mbed-trace) library.
+
 ## Troubleshooting
 
 - Device initializes but can't register to Pelion