84 строки
5.0 KiB
Markdown
84 строки
5.0 KiB
Markdown
# Azure SDK for C++
|
|
|
|
[](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=1611&branchName=master)
|
|
|
|
This repository is for active development of the Azure SDK for C++.
|
|
|
|
## Getting started
|
|
|
|
To get started with a specific library, see the **README.md** file located in the library's project folder. You can find service libraries in the `/sdk` directory.
|
|
|
|
### Prerequisites
|
|
|
|
> CMake version 3.12 is required to build these libraries
|
|
|
|
## Latest Release
|
|
|
|
> NOTE: All code in this repro is in development state and should not be used in production.
|
|
|
|
### Previous GA Releases
|
|
|
|
- [TODO](https://azure.github.io/azure-sdk/releases/Year-Month/cpp.html)
|
|
|
|
> NOTE: If you need to ensure your code is ready for production use one of the stable, non-preview libraries.
|
|
|
|
### Client: Previous Versions
|
|
|
|
TODO
|
|
|
|
### Management
|
|
|
|
Libraries which enable you to provision specific resources. They are responsible for directly mirroring and consuming Azure service's REST endpoints. Management library directories contain `-mgmt-`, e.g. `azure-mgmt-keyvault`.
|
|
|
|
## Need help
|
|
|
|
- For reference documentation visit the `Azure SDK for C++ documentation`[todo].
|
|
- For tutorials, samples, quick starts and other documentation, visit [Azure for C++ Developers](https://docs.microsoft.com/azure/).
|
|
- For build reports on code quality, test coverage, etc, visit [Azure SDK for C++](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-cpp/index.html).
|
|
- File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-cpp/issues/new/choose).
|
|
|
|
## Navigating the repository
|
|
|
|
### Master branch
|
|
|
|
The master branch has the most recent code with new features and bug fixes. It does **not** represent latest released **GA** SDK.
|
|
|
|
### Release branches (Release tagging)
|
|
|
|
For each package we release there will be a unique git tag created that contains the name and the version of the package to mark the commit of the code that produced the package. This tag will be used for servicing via hotfix branches as well as debugging the code for a particular preview or stable release version.
|
|
Format of the release tags are `<package-name>_<package-version>`. For more information please see [our branching strategy](https://github.com/Azure/azure-sdk/blob/master/docs/policies/repobranching.md#release-tagging).
|
|
|
|
## Contributing
|
|
|
|
For details on contributing to this repository, see the [contributing guide](CONTRIBUTING.md).
|
|
|
|
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, view [Microsoft's CLA](https://cla.microsoft.com).
|
|
|
|
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
|
|
|
|
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.
|
|
|
|
### Additional Helpful Links for Contributors
|
|
|
|
Many people all over the world have helped make this project better. You'll want to check out:
|
|
|
|
- [What are some good first issues for new contributors to the repo?](https://github.com/azure/azure-sdk-for-cpp/issues?q=is%3Aopen+is%3Aissue+label%3A%22up+for+grabs%22)
|
|
- [How to build and test your change](CONTRIBUTING.md#developer-guide)
|
|
- [How you can make a change happen!](CONTRIBUTING.md#pull-requests)
|
|
- Frequently Asked Questions (FAQ) and Conceptual Topics in the detailed [Azure SDK for C++ wiki](https://github.com/azure/azure-sdk-for-cpp/wiki).
|
|
|
|
### Community
|
|
|
|
Chat with other community members [](https://gitter.im/azure/azure-sdk-for-cpp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
### Reporting security issues and security bugs
|
|
|
|
Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) <secure@microsoft.com>. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the [Security TechCenter](https://www.microsoft.com/msrc/faqs-report-an-issue).
|
|
|
|
### License
|
|
|
|
Azure SDK for C++ is licensed under the [MIT](LICENSE) license.
|
|
|
|
|
|
|