contribution readmes
This commit is contained in:
Родитель
3b7bde2772
Коммит
5953f2f2c9
|
@ -0,0 +1,54 @@
|
|||
Contributing to Microsoft Cognitive Services Client Libraries
|
||||
===============================================
|
||||
|
||||
So, you want to contribute on a client SDK for one of the Microsoft Cognitive Services.
|
||||
Here's what you need to know.
|
||||
|
||||
1. Each SDK must include both a client library and a sample showing the API in
|
||||
action
|
||||
|
||||
2. When building an SDK, it's important you support the most common development
|
||||
platforms and that we are consistent from project to project. We require you
|
||||
to build the following, using the associated coding guidelines, in priority
|
||||
order:
|
||||
|
||||
- .NET (Coding guidelines below)
|
||||
|
||||
- Android [(Coding guidelines for
|
||||
Java)](<http://source.android.com/source/code-style.html>)
|
||||
|
||||
- iOS Objective-C [(Coding guidelines for
|
||||
Cocoa)](<https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html>)
|
||||
|
||||
- Optional: Client Javascript ([Coding guidelines for
|
||||
npm](<https://docs.npmjs.com/misc/coding-style>))
|
||||
|
||||
3. Samples are important for illustrating how to actually call into the API.
|
||||
Samples should be as visual and reusable as possible.
|
||||
|
||||
Do:
|
||||
|
||||
- Create a UI sample when possible.
|
||||
|
||||
- Make your sample user friendly. Expect that developers will want to try
|
||||
different mainline scenarios and key APIs.
|
||||
|
||||
- Create code that's easy for other developers to copy/paste into their
|
||||
own solutions
|
||||
|
||||
Consider:
|
||||
|
||||
- Adding UI to allow devs to quickly copy/paste subscription keys, instead
|
||||
of updating them in the code or using a config file. The
|
||||
FaceAPI-WPF-Samples.sln provides an example.
|
||||
|
||||
Don't:
|
||||
|
||||
- Leave your subscription key in the source of samples. You do not want
|
||||
your key to be abused by others.
|
||||
|
||||
4. Always create a README.md for your top-level API root and for each platform.
|
||||
|
||||
- Use the existing README.md files as a reference for what information is
|
||||
useful here. In general, you want to describe the functionality of the
|
||||
API as well as specifics for how to build and run the project(s).
|
|
@ -0,0 +1,9 @@
|
|||
Copyright (c) Microsoft Corporation
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Microsoft Cognitive Services Client SDK License for Sample Image
|
||||
|
||||
*This license applies only to the sample images. The SDK code is licensed separately, please refer to [LICENSE](</LICENSE.md>)*
|
||||
|
||||
Microsoft may make sample images available in connection with the SDK for the purposes of illustrating the operation of Microsoft Cognitive Services (https://www.microsoft.com/cognitive-services). If no separate license terms are provided with the images, Microsoft grants you a personal, nonexclusive, revocable, royalty-free right to use the images solely within your organization to test the operation of Microsoft Cognitive Services, provided that you agree to indemnify, hold harmless, and defend Microsoft and its suppliers from and against any claims or lawsuits, including attorneys’ fees, that arise or result from the use or distribution of the images. Except as expressly provided in this section you have no license to modify or distribute the images.
|
|
@ -0,0 +1,14 @@
|
|||
Microsoft Cognitive Services SDK
|
||||
|
||||
Copyright (c) Microsoft Corporation
|
||||
|
||||
All rights reserved.
|
||||
|
||||
*This license applies only to the SDK code. Sample images are licensed separately, please refer to [LICENSE-IMAGE](</LICENSE-IMAGE.md>)*
|
||||
|
||||
MIT License
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
Загрузка…
Ссылка в новой задаче