Merge branch 'master' into fixes/1859-missing-MEF-exports

Author: jcansdale

CONTRIBUTING.md

@@ -13,16 +13,16 @@ This project adheres to the [Open Code of Conduct][code-of-conduct]. By particip
 
 ## Submitting a pull request
 
-0. [Fork][] and clone the repository (see Build Instructions in the [README][readme])
-0. Create a new branch: `git checkout -b my-branch-name`
-0. Make your change, add tests, and make sure the tests still pass
-0. Push to your fork and [submit a pull request][pr]
-0. Pat your self on the back and wait for your pull request to be reviewed and merged.
+1. [Fork][] and clone the repository (see Build Instructions in the [README][readme])
+2. Create a new branch: `git checkout -b my-branch-name`
+3. Make your change, add tests, and make sure the tests still pass
+4. Push to your fork and [submit a pull request][pr]
+5. Pat your self on the back and wait for your pull request to be reviewed and merged.
 
 Here are a few things you can do that will increase the likelihood of your pull request being accepted:
 
-- Follow the existing code's style.
-- Write tests.
+- Follow the style/format of the existing code.
+- Write tests for your changes.
 - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
 - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 
@@ -38,7 +38,7 @@ There are certain areas of the extension that are restricted in what they can do
 ### Bug Reporting
 
 Here are a few helpful tips when reporting a bug:
-- Verify the bug resides in the GitHub for Visual Studio extension
+- Verify that the bug resides in the GitHub for Visual Studio extension
   - A lot of functionality provided by this extension resides in the Team Explorer pane, alongside other non-GitHub tools to manage and collaborate on source code, including Visual Studio's Git support, which is owned by Microsoft.
   - If this bug not is related to the GitHub extension, visit the [Visual Studio support page](https://www.visualstudio.com/support/support-overview-vs) for help
 - Screenshots are very helpful in diagnosing bugs and understanding the state of the extension when it's experiencing problems. Please include them whenever possible.

ISSUE_TEMPLATE.md

@@ -1,6 +1,24 @@
-Hello! Please read the contributing guidelines before submitting an issue regarding the GitHub Extension for Visual Studio.
+<!-- Hello! Please read the [contributing guidelines](https://github.com/github/VisualStudio/blob/master/CONTRIBUTING.md) before submitting an issue regarding the GitHub Extension for Visual Studio. -->
+
+## Version
 
 - GitHub Extension for Visual Studio version:
 - Visual Studio version:
 
-__What happened__ (with steps, logs and screenshots, if possible)
+## What happened
+
+**Steps to Reproduce**
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+**Expected behavior:** [What you expect to happen]
+
+**Actual behavior:** [What actually happens]
+
+**Screenshot or GIF:**
+
+**Log file:**
+
+<!-- Include the log file. Logs can be found at: `%LOCALAPPDATA%\GitHubVisualStudio\extension.log` -->

README.md

@@ -85,6 +85,10 @@ To build and install a `Release` configuration VSIX:
 build.cmd Release
 install.cmd Release
 ```
+## Logs
+Logs can be viewed at the following location:
+
+`%LOCALAPPDATA%\GitHubVisualStudio\extension.log`
 
 ## More information
 - Andreia Gaita's [presentation](https://www.youtube.com/watch?v=hz2hCO8e_8w) at Codemania 2016 about this extension.

appveyor.yml

@@ -1,5 +1,5 @@
 os: Visual Studio 2017
-version: '2.5.4.{build}'
+version: '2.5.5.{build}'
 skip_tags: true
 install:
 - ps: |

docs/developer/how-viewmodels-are-turned-into-views.md

@@ -65,8 +65,8 @@ This is the basis for converting view models to views.
 
 There are currently two top-level controls for our UI:
 
-- [GitHubDialogWindow](../src/GitHub.VisualStudio/Views/Dialog/GitHubDialogWindow.xaml) for the dialog which shows the login, clone, etc views
-- [GitHubPaneView](../src/GitHub.VisualStudio/Views/GitHubPane/GitHubPaneView.xaml) for the GitHub pane
+- [GitHubDialogWindow](../../src/GitHub.VisualStudio/Views/Dialog/GitHubDialogWindow.xaml) for the dialog which shows the login, clone, etc views
+- [GitHubPaneView](../../src/GitHub.VisualStudio/Views/GitHubPane/GitHubPaneView.xaml) for the GitHub pane
 
 In the resources for each of these top-level controls we define a `DataTemplate` like so:
 
@@ -77,10 +77,10 @@ In the resources for each of these top-level controls we define a `DataTemplate`
 </DataTemplate>
 ```
 
-The `DataTemplate.DataType` here applies the template to all classes inherited from [`GitHub.ViewModels.ViewModelBase`](../src/GitHub.Exports.Reactive/ViewModels/ViewModelBase.cs) [1]. The template defines a single `ContentControl` whose contents are created by a `ViewLocator`.
+The `DataTemplate.DataType` here applies the template to all classes inherited from [`GitHub.ViewModels.ViewModelBase`](../../src/GitHub.Exports.Reactive/ViewModels/ViewModelBase.cs) [1]. The template defines a single `ContentControl` whose contents are created by a `ViewLocator`.
 
-The [`ViewLocator`](../src/GitHub.VisualStudio/Views/ViewLocator.cs) class is an `IValueConverter` which then creates an instance of the appropriate view for the view model using MEF.
+The [`ViewLocator`](../../src/GitHub.VisualStudio/Views/ViewLocator.cs) class is an `IValueConverter` which then creates an instance of the appropriate view for the view model using MEF.
 
 And thus a view model becomes a view.
 
-[1]: it would be nice to make it apply to all classes that inherit `IViewModel` but unfortunately WPF's `DataTemplate`s don't work with interfaces.
+[1]: it would be nice to make it apply to all classes that inherit `IViewModel` but unfortunately WPF's `DataTemplate`s don't work with interfaces.

lib/Octokit.GraphQL.0.1.1-beta.nupkg

@@ -50,11 +50,11 @@
     <Reference Include="Newtonsoft.Json, Version=9.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
       <HintPath>..\..\packages\Newtonsoft.Json.9.0.1\lib\net45\Newtonsoft.Json.dll</HintPath>
     </Reference>
-    <Reference Include="Octokit.GraphQL, Version=0.1.0.0, Culture=neutral, PublicKeyToken=0be8860aee462442, processorArchitecture=MSIL">
-      <HintPath>..\..\packages\Octokit.GraphQL.0.1.0-beta\lib\netstandard1.1\Octokit.GraphQL.dll</HintPath>
+    <Reference Include="Octokit.GraphQL, Version=0.1.1.0, Culture=neutral, PublicKeyToken=0be8860aee462442, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Octokit.GraphQL.0.1.1-beta\lib\netstandard1.1\Octokit.GraphQL.dll</HintPath>
     </Reference>
-    <Reference Include="Octokit.GraphQL.Core, Version=0.1.0.0, Culture=neutral, PublicKeyToken=0be8860aee462442, processorArchitecture=MSIL">
-      <HintPath>..\..\packages\Octokit.GraphQL.0.1.0-beta\lib\netstandard1.1\Octokit.GraphQL.Core.dll</HintPath>
+    <Reference Include="Octokit.GraphQL.Core, Version=0.1.1.0, Culture=neutral, PublicKeyToken=0be8860aee462442, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Octokit.GraphQL.0.1.1-beta\lib\netstandard1.1\Octokit.GraphQL.Core.dll</HintPath>
     </Reference>
     <Reference Include="Serilog, Version=2.0.0.0, Culture=neutral, PublicKeyToken=24c2f752a8e58a10, processorArchitecture=MSIL">
       <HintPath>..\..\packages\Serilog.2.5.0\lib\net46\Serilog.dll</HintPath>

src/GitHub.Api/GitHub.Api.csproj

@@ -1,4 +1,5 @@
 using System;
+using System.Threading;
 using System.Threading.Tasks;
 using GitHub.Extensions;
 using GitHub.Primitives;
@@ -23,7 +24,7 @@ public GraphQLKeychainCredentialStore(IKeychain keychain, HostAddress address)
             this.address = address;
         }
 
-        public async Task<string> GetCredentials()
+        public async Task<string> GetCredentials(CancellationToken cancellationToken = default)
         {
             var userPass = await keychain.Load(address).ConfigureAwait(false);
             return userPass?.Item2;

src/GitHub.Api/GraphQLKeychainCredentialStore.cs

@@ -72,6 +72,7 @@ Task<User> LoginWithToken(
         /// Logs out of GitHub server.
         /// </summary>
         /// <param name="hostAddress">The address of the server.</param>
+        /// <param name="client">An octokit client configured to access the server.</param>
         Task Logout(HostAddress hostAddress, IGitHubClient client);
     }
 }

src/GitHub.Api/ILoginManager.cs

@@ -34,8 +34,10 @@ public class LoginManager : ILoginManager
         /// </summary>
         /// <param name="keychain">The keychain in which to store credentials.</param>
         /// <param name="twoFactorChallengeHandler">The handler for 2FA challenges.</param>
+        /// <param name="oauthListener">The callback listener to signal successful login.</param>
         /// <param name="clientId">The application's client API ID.</param>
         /// <param name="clientSecret">The application's client API secret.</param>
+        /// <param name="scopes">List of scopes to authenticate for</param>
         /// <param name="authorizationNote">An note to store with the authorization.</param>
         /// <param name="fingerprint">The machine fingerprint.</param>
         public LoginManager(