Skip to content
This repository has been archived by the owner on Jan 30, 2021. It is now read-only.

Commit

Permalink
Updated ReadMe & Contributing (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
lightfrenzy committed Jul 6, 2016
1 parent c01e861 commit 2bc6779
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 15 deletions.
45 changes: 45 additions & 0 deletions CONTRIBUTING.MD
@@ -0,0 +1,45 @@
Contributing to Microsoft Cognitive Services Client Libraries & Samples
===============================================
So, you want to contribute on a client library or sample for one of the Microsoft Cognitive Services.
Here's what you need to know.

1. Each SDK should include both a client library and a sample showing the API in
action

2. When working on an SDK, it's important that we are consistent from project to project, so we ask you to follow the coding guidelines below:

- Windows [(Coding guidelines for C#)](https://msdn.microsoft.com/en-us/library/ff926074.aspx) -- also reference our [common Windows code](https://github.com/Microsoft/Cognitive-common-windows) for building samples

- 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.

Happy coding!
30 changes: 15 additions & 15 deletions README.md
@@ -1,25 +1,25 @@
Microsoft Cognitive Services Entity Linking Client SDK
========================================
# Microsoft Entity Linking Intelligence Service: Windows Client Library & Sample
This repo contains the Windows client library for the Microsoft Entity Linking Intelligence Service, an offering within [Microsoft Cognitive Services](https://www.microsoft.com/cognitive-services), formerly known as Project Oxford.
* [Learn about the Entity Linking Intelligence Service](https://www.microsoft.com/cognitive-services/en-us/entity-linking-intelligence-service)
* [Read the documentation](https://www.microsoft.com/cognitive-services/en-us/entitylinking-api/documentation/overview)
* [Find more SDKs & Samples](https://www.microsoft.com/cognitive-services/en-us/SDK-Sample?api=entity%20linking)

This repo contains the client libraries that demonstrate Microsoft’s cloud-based entity linking algorithms to
detects all entities mentioned within the input text, and then subsequently links them to each reference point.
See the tech in action on [our demo page](<https://www.microsoft.com/cognitive-services/en-us/entity-linking-intelligence-service) or
learn more about the API with [our documentation](<https://github.com/Microsoft/ProjectOxford-Documentation/blob/master/Content/en-us/EntityLinking/Home.md>).

Contributing
============
We welcome contributions and are always looking for new SDKs, input, and
suggestions. Feel free to file issues on the repo and we'll address them as we can. You can also learn more about how you can help on the [Contribution
Rules & Guidelines](</CONTRIBUTING.md>).
## Contributing
We welcome contributions. Feel free to file issues and pull requests on the repo and we'll address them as we can. Learn more about how you can help on our [Contribution Rules & Guidelines](</CONTRIBUTING.md>).

For questions, feedback, or suggestions about Microsoft Cognitive Services, feel free to reach out to us directly.
You can reach out to us anytime with questions and suggestions using our communities below:
- **Support questions:** [StackOverflow](<https://stackoverflow.com/questions/tagged/microsoft-cognitive>)
- **Feedback & feature requests:** [Cognitive Services UserVoice Forum](<https://cognitive.uservoice.com>)

- [Cognitive Services UserVoice Forum](<https://cognitive.uservoice.com>)
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.

License
=======

## License
All Microsoft Cognitive Services SDKs and samples are licensed with the MIT License. For more details, see
[LICENSE](</LICENSE.md>).

Sample images are licensed separately, please refer to [LICENSE-IMAGE](</LICENSE-IMAGE.md>).

## Developer Code of Conduct
Developers using Cognitive Services, including this client library & sample, are expected to follow the “Developer Code of Conduct for Microsoft Cognitive Services”, found at [http://go.microsoft.com/fwlink/?LinkId=698895](http://go.microsoft.com/fwlink/?LinkId=698895).

0 comments on commit 2bc6779

Please sign in to comment.