Merge pull request #68 from watson-developer-cloud/development

Watson Developer Cloud .NET Standard SDK v0.1.0-alpha

.github/CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# Questions
+
+If you are having problems using the APIs or have a question about the IBM Watson Services, please ask a question on [dW Answers][dw-answers] or [Stack Overflow][stack-overflow].
+
+# Coding Standard
+
+* Use spaces instead of tab characters, a tab should be 4 spaces.
+* Class names should be `PascalCase` (e.g. SpeechToText), with no underscores `_`.
+* Structures should follow the same naming standards as classes.
+* Use [Allman style][allman-style] braces, where each brace begins on a new line. A single line statement block can go without braces but the block must be properly indented on its own line and it must not be nested in other statement blocks that use braces
+* Use `_camelCase` for internal and private fields and use `readonly` where possible. Prefix instance fields with `_`, static fields with `s_` and thread static fields with `t_`. When used on static fields, `readonly` should come after `static` (i.e. `static readonly` not `readonly static`).
+* No public variables, always use public properties unless there is no other workaround.
+* `Properties` should be `PascalCase`, _no underscores_. (e.g. public bool IsReady { get; set; })
+* `Constants` should be all upper case (e.g. static readonly string CONFIG_FILE = "/Config.json"). This includes enumerations.
+* All `public functions` and types of all classes should be _fully documented_ using the XML comment style.
+* `Local variables` should use camelCase. (e.g. var widgetConnector = new WidgetConnector())
+* Use `protected` on variables & functions only if you plan to inherit from the class or there is a good chance we will need to be polymorphic.
+* Use `region` to separate parts of a class based on functionality.
+* Always specify the `visibility`, even if it's the default (i.e. private string _foo not string _foo). Visibility should be the first modifier (i.e. public abstract not abstract public).
+* `Namespace` imports should be specified at the top of the file, outside of namespace declarations, after the license and should be sorted alphabetically.
+* Avoid more than one empty line at any time. For example, do not have two blank lines between members of a type.
+* Avoid spurious `free spaces`. For example avoid if (someVar == 0)..., where the dots mark the spurious free spaces. Consider enabling "View White Space (Ctrl+E, S)" if using Visual Studio, to aid detection.
+* Only use `var` when it's obvious what the variable type is (i.e. var stream = new FileStream(...) not var stream = OpenStandardInput()).
+* `Fields` should be specified at the top within type declarations.
+
+# Issues
+
+If you encounter an issue with the .NET Standard SDK, you are welcome to submit a [bug report][dotnet-sdk-issues]. Before that, please search for similar issues. It's possible somebody has already encountered this issue.
+
+# Pull Requests
+
+If you want to contribute to the repository, follow these steps:
+
+1. Fork the repo.
+1. Develop and test your code changes Make sure you work in a feature branch. **PLEASE do not do your work in `master`.**
+1. Add a unit test for any new classes you add. Only refactoring and documentation changes require no new tests.
+1. Run unit tests within Visual Studio.
+1. Commit your changes.
+1. Push to your fork and submit a pull request.
+
+# Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+   have the right to submit it under the open source license
+   indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+   of my knowledge, is covered under an appropriate open source
+   license and I have the right under that license to submit that
+   work with modifications, whether created in whole or in part
+   by me, under the same open source license (unless I am
+   permitted to submit under a different license), as indicated
+   in the file; or
+
+(c) The contribution was provided directly to me by some other
+   person who certified (a), (b) or (c) and I have not modified
+   it.
+
+(d) I understand and agree that this project and the contribution
+   are public and that a record of the contribution (including all
+   personal information I submit with it, including my sign-off) is
+   maintained indefinitely and may be redistributed consistent with
+   this project or the open source license(s) involved.
+
+[dw-answers]: https://developer.ibm.com/answers/questions/ask/?topics=watson
+[stack-overflow]: http://stackoverflow.com/questions/ask?tags=ibm-watson
+[allman-style]: http://en.wikipedia.org/wiki/Indent_style#Allman_style
+[dotnet-sdk-issues]: https://github.com/watson-developer-cloud/dotnet-standard-sdk/issues

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,16 @@
+Remember, an issue is not the place to ask questions. You can use [Stack Overflow](http://stackoverflow.com/questions/tagged/ibm-watson) for that, or you may want to start a discussion on the [dW Answers](https://developer.ibm.com/answers/questions/ask/?topics=watson).
+
+Before you open an issue, please check if a similar issue already exists or has been closed before.
+
+### When reporting a bug, please be sure to include the following:
+
+- [ ] Start the title with the service name in brackets:  `[speech-to-text] websockets...`
+- [ ] Steps to reproduce
+- [ ] Expected behavior
+- [ ] Actual behavior
+- [ ] Unity SDK version
+
+### When you open an issue for a feature request, please add as much detail as possible:
+- [ ] A descriptive title starting with the service name
+- [ ] A description of the problem you're trying to solve
+- [ ] A suggested solution if possible

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here.
+
+
+Thanks for contributing to the Watson Developer Cloud!

.gitignore

@@ -20,7 +20,6 @@ x86/
 bld/
 [Bb]in/
 [Oo]bj/
-[Ll]og/
 
 # Visual Studio 2015 cache/options directory
 .vs/
@@ -80,8 +79,6 @@ ipch/
 *.opensdf
 *.sdf
 *.cachefile
-*.VC.db
-*.VC.VC.opendb
 
 # Visual Studio profiler
 *.psess
@@ -140,16 +137,11 @@ publish/
 # Publish Web Output
 *.[Pp]ublish.xml
 *.azurePubxml
-# TODO: Comment the next line if you want to checkin your web deploy settings
+# TODO: Comment the next line if you want to checkin your web deploy settings 
 # but database connection strings (with potential passwords) will be unencrypted
 *.pubxml
 *.publishproj
 
-# Microsoft Azure Web App publish settings. Comment the next line if you want to
-# checkin your Azure Web App publish settings, but sensitive information contained
-# in these scripts will be unencrypted
-PublishScripts/
-
 # NuGet Packages
 *.nupkg
 # The packages folder can be ignored because of Package Restore
@@ -170,11 +162,12 @@ csx/
 ecf/
 rcf/
 
-# Windows Store app package directories and files
+# Microsoft Azure ApplicationInsights config file
+ApplicationInsights.config
+
+# Windows Store app package directory
 AppPackages/
 BundleArtifacts/
-Package.StoreAssociation.xml
-_pkginfo.txt
 
 # Visual Studio cache files
 # files ending in .cache can be ignored
@@ -193,10 +186,6 @@ ClientBin/
 node_modules/
 orleans.codegen.cs
 
-# Since there are multiple workflows, uncomment next line to ignore bower_components
-# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
-#bower_components/
-
 # RIA/Silverlight projects
 Generated_Code/
 
@@ -242,11 +231,8 @@ _Pvt_Extensions
 
 # Paket dependency manager
 .paket/paket.exe
-paket-files/
 
 # FAKE - F# Make
 .fake/
-
-# JetBrains Rider
-.idea/
-*.sln.iml
+/src/IBM.WatsonDeveloperCloud.LanguageTranslator.Test/appsettings.json
+/test/IBM.WatsonDeveloperCloud.LanguageTranslator.IntegrationTests/appsettings.json

.utility/generate_html.ps1

@@ -0,0 +1,40 @@
+function New-TableOfContents($path)
+{
+    # Verify the path exists and retrieve the official full path
+    $root = (Get-Item $path).FullName
+
+    Write-Output "<!DOCTYPE html>
+<html>
+<head>
+    <meta charset=`"utf-8`">
+    <meta http-equiv=`"X-UA-Compatible`" content=`"IE=edge`">
+    <meta name=`"viewport`" content=`"width=device-width, initial-scale=1`">
+    <title>IBM Watson Developer Cloud</title>
+    <link rel=`"stylesheet`" href=`"https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css`" integrity=`"sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u`" crossorigin=`"anonymous`">
+</head>
+<body>
+<div class=`"container`">
+    <div class=`"page-header`">
+        <h1>IBM Watson Developer Cloud .NET Standard SDK</h1>
+    </div>
+    <p><a href=`"http://www.ibm.com/watson/developercloud/`">Info</a>
+        | <a href=`"http://www.ibm.com/watson/developercloud/doc/index.html`">Documentation</a>
+    </p>
+    <p>Documentation by branch/tag:</p>
+    <ul>
+"
+    # For each child item that is a directory, create a link containing the relative path
+    Get-ChildItem $root | where { $_.PSIsContainer -eq $true } |% {
+        # Strip the root out of the path name (including the trailing slash)
+        # in order to create a hyperlink that can be used from any location
+        $relPath = $_.FullName.Remove(0, $root.Length + 1)
+        $htmlPath = "docs/" + $_.Name +"/html/index.html"
+        # Write the link out - this is where you could get fancier with what you output
+        # For example, you could include the last modified date/time, etc.
+        Write-Output "<li><a href=`"$htmlPath`">$relPath</a><br /></li>"
+    }
+    Write-Output "        </ul>
+</div>
+</body>
+</html>"
+}