chore: Update md files from linter feedback (#528)
Co-authored-by: Jelani Brandon <jelanibrandon@gmail.com>
This commit is contained in:
Jelani Brandon
GitHub
Родитель
3e0eca3494
Коммит
6c22758ff4
|
|
@ -1,20 +1,23 @@
|
|||
**The Azure IoT SDKs team wants to hear from you!**
|
||||
# The Azure IoT SDKs team wants to hear from you
|
||||
|
||||
- [Need Support?](#need-support)
|
||||
- [File a bug (code or documentation)](#file-a-bug-code-or-documentation)
|
||||
- [Contribute code and/or documentation](#contribute-code-andor-documentation)
|
||||
- [Commit messages](#commit-messages)
|
||||
- [Editing module requirements](#editing-module-requirements)
|
||||
- [Adding new files](#adding-new-files)
|
||||
- [Commit messages](#commit-messages)
|
||||
- [Editing module requirements](#editing-module-requirements)
|
||||
- [Adding new files](#adding-new-files)
|
||||
|
||||
## Need Support
|
||||
|
||||
# Need Support?
|
||||
- **Have a feature request for SDKs?** Please post it on [User Voice](https://feedback.azure.com/forums/321918-azure-iot) to help us prioritize
|
||||
- **Have a technical question?** Ask on [Stack Overflow with tag "azure-iot-hub"](https://stackoverflow.com/questions/tagged/azure-iot-hub)
|
||||
- **Need Support?** Every customer with an active Azure subscription has access to [support](https://docs.microsoft.com/en-us/azure/azure-supportability/how-to-create-azure-support-request) with guaranteed response time. Consider submitting a ticket and get assistance from Microsoft support team
|
||||
- **Found a bug?** Please help us fix it by thoroughly documenting it and filing an issue on GitHub (See below).
|
||||
|
||||
# File a bug (code or documentation)
|
||||
## File a bug (code or documentation)
|
||||
|
||||
That is definitely something we want to hear about. Please open an issue on github, we'll address it as fast as possible. Typically here's the information we're going to ask for to get started:
|
||||
|
||||
- What version of the SDK are you using?
|
||||
- Do you have a snippet of code that would help us reproduce the bug?
|
||||
- Do you have logs showing what's happening?
|
||||
|
|
@ -22,7 +25,8 @@ That is definitely something we want to hear about. Please open an issue on gith
|
|||
Our SDK is entirely open-source and we do accept pull-requests if you feel like taking a stab at fixing the bug and maybe adding your name to our commit history :) Please mention
|
||||
any relevant issue number in the pull request description.
|
||||
|
||||
# Contribute code and/or documentation
|
||||
## Contribute code and/or documentation
|
||||
|
||||
We look at all pull requests submitted against the `master` branch carefully. We also actively use the [Wiki](https://github.com/Azure/azure-iot-sdk-node/wiki) for longer-form documents. The wiki can be cloned and used as a regular Git repository so feel free to contribute there too!
|
||||
|
||||
As far as code is concerned the code associated with the PR will be pulled and run through the gated build before it makes it to the master branch. As much as possible, we insist on having tests associated with the code, and if necessary, additions/modifications to the requirement documents. As a matter of fact, the build will fail if code coverage goes down.
|
||||
|
|
@ -36,7 +40,7 @@ sure your plans and ours are in sync :) Just open an issue on github and tag it
|
|||
|
||||
This project follows the [Conventional Commits convention](https://www.conventionalcommits.org), meaning that your commits message should be structured as follows:
|
||||
|
||||
```
|
||||
```Shell
|
||||
<type>[optional scope]: <description>
|
||||
[optional body]
|
||||
[optional footer]
|
||||
|
|
@ -51,9 +55,11 @@ The commit should contains one of the following structural elements as the \<typ
|
|||
If you are new to this convention you can use `npm run commit` instead of `git commit` and follow the guided instructions.
|
||||
|
||||
## Editing module requirements
|
||||
|
||||
We use requirement documents to describe the expected behavior for each code modules. It works as a basis to understand what tests need to be written.
|
||||
|
||||
When contributing to markdown requirement docs (located in the `devdoc` folder alongside the code, you should use `99` for a developer id, and just increment the last number of the requirement to be unique.
|
||||
|
||||
## Adding new files
|
||||
|
||||
If your contribution is not part of an already existed code, you must create a new requirement file and a new set of unit tests project in the appropriate `devdoc` and `test` directories.
|
||||
|
|
|
|||
|
|
@ -12,18 +12,22 @@ The commands in the comments can be run directly in a command prompt.
|
|||
-->
|
||||
|
||||
# Context
|
||||
|
||||
- **OS and version used:** <VERSION> (Windows 10, Ubuntu 15.04, etc. )
|
||||
- **Python version:** <VERSION> (in a command prompt: python --version )
|
||||
- **pip version:** <VERSION> (in a command prompt: pip --version )
|
||||
- **list of installed packages:** <VERSION> ( in a command prompt, from the directory containing your code: pip list )
|
||||
- **cloned repo:** <VERSION> ( **If** you are using a cloned sdk repository, in a command prompt: git describe )
|
||||
|
||||
# Description of the issue:
|
||||
## Description of the issue
|
||||
|
||||
Please be as detailed as possible: which feature has a problem, how often does it fail, etc.
|
||||
|
||||
# Code sample exhibiting the issue:
|
||||
## Code sample exhibiting the issue
|
||||
|
||||
Please remove any connection string information!
|
||||
|
||||
# Console log of the issue:
|
||||
## Console log of the issue
|
||||
|
||||
Consider setting the DEBUG environment variable to '*'. This will produce a much more verbose output that will help debugging
|
||||
Don't forget to remove any connection string information!
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
Thank you for helping us improve the Azure IoT Python SDK!
|
||||
# Thank you for helping us improve the Azure IoT Python SDK!
|
||||
|
||||
## Need Support
|
||||
|
||||
# Need Support?
|
||||
- **Have a feature request for SDKs?** Please post it on [User Voice](https://feedback.azure.com/forums/321918-azure-iot) to help us prioritize
|
||||
- **Have a technical question?** Ask on [Stack Overflow with tag "azure-iot-hub"](https://stackoverflow.com/questions/tagged/azure-iot-hub)
|
||||
- **Need Support?** Every customer with an active Azure subscription has access to [support](https://docs.microsoft.com/en-us/azure/azure-supportability/how-to-create-azure-support-request) with guaranteed response time. Consider submitting a ticket and get assistance from Microsoft support team
|
||||
|
|
@ -10,16 +11,19 @@ Here's a little checklist of things that will help it make its way to the reposi
|
|||
This being said, the more you do, the quicker it'll go through our gated build!
|
||||
-->
|
||||
|
||||
# Checklist
|
||||
## Checklist
|
||||
|
||||
- [ ] I have read the [contribution guidelines](https://github.com/Azure/azure-iot-sdk-python/.github/CONTRIBUTING.md).
|
||||
- [ ] I added or modified the existing tests to cover the change (we do not allow our test coverage to go down).
|
||||
- If this is a modification that impacts the behavior of a public API
|
||||
- [ ] I edited the corresponding document in the `devdoc` folder and added or modified requirements.
|
||||
|
||||
# Reference/Link to the issue solved with this PR (if any)
|
||||
## Reference/Link to the issue solved with this PR (if any)
|
||||
|
||||
## Description of the problem
|
||||
|
||||
# Description of the problem
|
||||
Please be as precise as possible: what issue you experienced, how often...
|
||||
|
||||
# Description of the solution
|
||||
## Description of the solution
|
||||
|
||||
How you solved the issue and the other things you considered and maybe rejected
|
||||
|
|
|
|||
12
README.md
12
README.md
|
|
@ -11,7 +11,6 @@ connection to the Azure IoTHub ecosystem.
|
|||
|
||||
*If you're looking for the v1.x.x client library, it is now preserved in the [v1-deprecated](https://github.com/Azure/azure-iot-sdk-python/tree/v1-deprecated) branch.*
|
||||
|
||||
|
||||
## Azure IoT SDK for Python
|
||||
|
||||
This repository contains the following libraries:
|
||||
|
|
@ -79,14 +78,14 @@ This SDK only supports the **MQTT protocol**.
|
|||
|
||||
#### Registry Manager
|
||||
|
||||
| Features | Status | Description |
|
||||
| Features | Status | Description |
|
||||
|---------------------------------------------------------------------------------------------------------------|--------------------------|------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| [Identity registry (CRUD)](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-identity-registry) | :heavy_check_mark: | Use your backend app to perform CRUD operation for individual device or in bulk. |
|
||||
| [Cloud-to-device messaging](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-c2d) | :heavy_multiplication_x: | Use your backend app to send cloud-to-device messages, and set up cloud-to-device message receivers. |
|
||||
| [Direct Methods operations](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-direct-methods) | :heavy_check_mark: | Use your backend app to invoke direct method on device. |
|
||||
| [Cloud-to-device messaging](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-c2d) | :heavy_check_mark: | Use your backend app to send cloud-to-device messages, and set up cloud-to-device message receivers. |
|
||||
| [Direct Methods operations](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-direct-methods) | :heavy_check_mark: | Use your backend app to invoke direct method on device. |
|
||||
| [Device Twins operations](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-device-twins) | :heavy_check_mark: | Use your backend app to perform device twin operations. *Twin reported property update callback and replace twin are in progress. |
|
||||
| [Query](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language) | :heavy_multiplication_x: | Use your backend app to perform query for information. |
|
||||
| [Jobs](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs) | :heavy_multiplication_x: | Use your backend app to perform job operation. |
|
||||
| [Query](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language) | :heavy_check_mark: | Use your backend app to perform query for information. |
|
||||
| [Jobs](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs) | :heavy_multiplication_x: | Use your backend app to perform job operation. |
|
||||
|
||||
### IoTHub Provisioning Service Library
|
||||
|
||||
|
|
@ -113,4 +112,3 @@ provided by the bot. You will only need to do this once across all repos using o
|
|||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче