Initialize skeleton docs
This commit is contained in:
Brandon Siegel
Родитель
5f39c8c89d
Коммит
2d6c513b83
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: "[BUG]"
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
***Exception or Stack Trace***
|
||||
Add the exception log and stack trace if available
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
|
||||
***Code Snippet***
|
||||
Add the code snippet that causes the issue.
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Setup (please complete the following information):**
|
||||
- OS: [e.g. iOS]
|
||||
- IDE : [e.g. IntelliJ]
|
||||
- Version of the Library used
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
|
||||
**Information Checklist**
|
||||
Kindly make sure that you have added all the following information above and checkoff the required fields otherwise we will treat the issuer as an incomplete report
|
||||
- [ ] Bug Description Added
|
||||
- [ ] Repro Steps Added
|
||||
- [ ] Setup information Added
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: "[FEATURE REQ]"
|
||||
labels: ''
|
||||
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.
|
||||
|
||||
**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.
|
||||
|
||||
**Information Checklist**
|
||||
Kindly make sure that you have added all the following information above and checkoff the required fields otherwise we will treat the issuer as an incomplete report
|
||||
- [ ] Description Added
|
||||
- [ ] Expected solution specified
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
name: Question/Query template
|
||||
about: Use this template to file a question/query for the SDK team
|
||||
title: "[QUERY]"
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Query/Question**
|
||||
A clear and concise ask/query.
|
||||
|
||||
***Why is this not a Bug or a feature Request?***
|
||||
A clear explanation of why is this not a bug or a feature request?
|
||||
|
||||
**Setup (please complete the following information if applicable):**
|
||||
- OS: [e.g. iOS]
|
||||
- IDE : [e.g. IntelliJ]
|
||||
- Version of the Library used
|
||||
|
||||
**Information Checklist**
|
||||
Kindly make sure that you have added all the following information above and checkoff the required fields otherwise we will treat the issuer as an incomplete report
|
||||
- [ ] Query Added
|
||||
- [ ] Setup information Added
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
# Microsoft Open Source Code of Conduct
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
|
||||
Resources:
|
||||
|
||||
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
|
||||
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
|
||||
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# How to contribute
|
||||
|
||||
If you encounter any bugs with the library please file an issue in the [Issues](https://github.com/Azure/azure-sdk-for-ios/issues) section of the project.
|
||||
|
||||
If you would like to become an active contributor to this project please follow the instructions provided in [Microsoft Azure Projects Contribution Guidelines](http://azure.github.com/guidelines.html).
|
||||
32
README.md
32
README.md
|
|
@ -1,14 +1,26 @@
|
|||
# Azure SDK for iOS
|
||||
|
||||
# Contributing
|
||||
This repository contains official iOS (Swift) libraries for Azure services.
|
||||
|
||||
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, visit https://cla.opensource.microsoft.com.
|
||||
## Getting started
|
||||
|
||||
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., status check, comment). Simply follow the instructions
|
||||
provided by the bot. You will only need to do this once across all repos using our CLA.
|
||||
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.
|
||||
|
||||
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.
|
||||
### Prerequisites
|
||||
Xcode 9.0 or higher is required to use these libraries.
|
||||
|
||||
## Need help?
|
||||
* File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-ios/issues/new/choose).
|
||||
* Check [previous questions](https://stackoverflow.com/questions/tagged/azure+ios) or ask new ones on StackOverflow using `azure` and `ios` tags.
|
||||
|
||||
## 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, visit
|
||||
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.
|
||||
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче