You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
9
4
10
-
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
5
+
Contributions to this project are [released][contribute-under-repo-license] to the public under the [project's open source license][license].
11
6
12
7
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
13
8
@@ -29,18 +24,29 @@ This helps us coordinate and reduce duplication.
29
24
-`GitHub.UI.Avalonia`
30
25
-`Atlassian.Bitbucket.UI.Windows`
31
26
-`GitHub.UI.Windows`
32
-
1. Push to your fork and [submit a pull request][pr]
27
+
1. Push to your fork and [submit a pull request][compare]
33
28
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
34
29
35
30
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
36
31
37
32
- Match existing code style.
38
33
- Write tests.
39
34
- 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.
40
-
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
35
+
- Write a [good commit message][commit-messages].
41
36
42
37
## Resources
43
38
44
-
-[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
[Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager) (GCM) is a secure Git credential helper built on [.NET](https://dotnet.microsoft.com) that runs on Windows, macOS, and Linux.
7
+
[Git Credential Manager][gcm] (GCM) is a secure Git credential helper built on [.NET][] that runs on Windows, macOS, and Linux.
8
8
9
-
Compared to Git's [built-in credential helpers]((https://git-scm.com/book/en/v2/Git-Tools-Credential-Storage)) (Windows: wincred, macOS: osxkeychain, Linux: gnome-keyring/libsecret) which provides single-factor authentication support working on any HTTP-enabled Git repository, GCM provides multi-factor authentication support for [Azure DevOps](https://dev.azure.com/), Azure DevOps Server (formerly Team Foundation Server), GitHub, Bitbucket, and GitLab.
9
+
Compared to Git's [built-in credential helpers][git-tools-credential-storage] (Windows: wincred, macOS: osxkeychain, Linux: gnome-keyring/libsecret) which provides single-factor authentication support working on any HTTP-enabled Git repository, GCM provides multi-factor authentication support for [Azure DevOps][], Azure DevOps Server (formerly Team Foundation Server), GitHub, and Bitbucket.
10
10
11
-
Git Credential Manager (GCM) replaces the .NET Framework-based [Git Credential Manager for Windows](https://github.com/microsoft/Git-Credential-Manager-for-Windows) (GCM), and the Java-based [Git Credential Manager for Mac and Linux](https://github.com/microsoft/Git-Credential-Manager-for-Mac-and-Linux) (Java GCM), providing a consistent authentication experience across all platforms.
11
+
Git Credential Manager (GCM) replaces the .NET Framework-based [Git Credential Manager for Windows][gcm-for-windows] (GCM), and the Java-based [Git Credential Manager for Mac and Linux][gcm-for-mac-and-linux] (Java GCM), providing a consistent authentication experience across all platforms.
12
12
13
13
## Current status
14
14
15
15
Git Credential Manager is currently available for Windows, macOS, and Linux\*. GCM only works with HTTP(S) remotes; you can still use Git with SSH:
We also provide a [.pkg installer](https://github.com/GitCredentialManager/git-credential-manager/releases/latest) with each release. To install, double-click the installation package and follow the instructions presented.
78
+
We also provide a [.pkg installer][latest-release] with each release. To install, double-click the installation package and follow the instructions presented.
79
79
80
80
#### Uninstall
81
81
@@ -121,15 +121,15 @@ run the following:
121
121
122
122
#### Ubuntu/Debian distributions
123
123
124
-
Download the latest [.deb package](https://github.com/GitCredentialManager/git-credential-manager/releases/latest), and run the following:
124
+
Download the latest [.deb package][latest-release], and run the following:
125
125
126
126
```shell
127
127
sudo dpkg -i <path-to-package>
128
128
git-credential-manager-core configure
129
129
```
130
130
131
131
**Note:** Although packages were previously offered on certain
**Note:** all Linux distributions [require additional configuration](https://aka.ms/gcm/credstores) to use GCM.
159
+
**Note:** all Linux distributions [require additional configuration][gcm-credstores] to use GCM.
160
160
161
161
---
162
162
163
163
### Windows
164
164
165
-
GCM is included with [Git for Windows](https://gitforwindows.org/), and the latest version is included in each new Git for Windows release. This is the preferred way to install GCM on Windows. During installation you will be asked to select a credential helper, with GCM being set as the default.
165
+
GCM is included with [Git for Windows][], and the latest version is included in each new Git for Windows release. This is the preferred way to install GCM on Windows. During installation you will be asked to select a credential helper, with GCM being set as the default.
You can also download the [latest installer](https://github.com/GitCredentialManager/git-credential-manager/releases/latest) for Windows to install GCM standalone.
171
+
You can also download the [latest installer][latest-release] for Windows to install GCM standalone.
172
172
173
173
**:warning: Important :warning:**
174
174
@@ -197,10 +197,10 @@ To uninstall, open Control Panel and navigate to the Programs and Features scree
197
197
#### Windows Subsystem for Linux (WSL)
198
198
199
199
Git Credential Manager can be used with the [Windows Subsystem for Linux
200
-
(WSL)](https://aka.ms/wsl) to enable secure authentication of your remote Git
200
+
(WSL)][ms-wsl] to enable secure authentication of your remote Git
201
201
repositories from inside of WSL.
202
202
203
-
[Please see the GCM on WSL docs](docs/wsl.md) for more information.
203
+
[Please see the GCM on WSL docs][gcm-wsl] for more information.
204
204
205
205
## Supported Git versions
206
206
@@ -215,50 +215,89 @@ Git that are not compatible.
215
215
- Git 2.26.2
216
216
217
217
This version of Git introduced a breaking change with parsing credential
218
-
configuration that GCM relies on. This issue was fixed in commit [`12294990`](https://github.com/git/git/commit/12294990c90e043862be9eb7eb22c3784b526340)
218
+
configuration that GCM relies on. This issue was fixed in commit [`12294990`][gcm-commit-12294990]
219
219
of the Git project, and released in Git 2.27.0.
220
220
221
221
## How to use
222
222
223
223
Once it's installed and configured, Git Credential Manager is called implicitly by Git.
224
224
You don't have to do anything special, and GCM isn't intended to be called directly by the user.
225
-
For example, when pushing (`git push`) to [Azure DevOps](https://dev.azure.com), [Bitbucket](https://bitbucket.org), or [GitHub](https://github.com), a window will automatically open and walk you through the sign-in process.
225
+
For example, when pushing (`git push`) to [Azure DevOps][], [Bitbucket][], or [GitHub][], a window will automatically open and walk you through the sign-in process.
226
226
(This process will look slightly different for each Git host, and even in some cases, whether you've connected to an on-premises or cloud-hosted Git host.)
227
227
Later Git commands in the same repository will re-use existing credentials or tokens that GCM has stored for as long as they're valid.
228
228
229
-
Read full command line usage [here](docs/usage.md).
229
+
Read full command line usage [here][gcm-usage].
230
230
231
231
### Configuring a proxy
232
232
233
-
See detailed information [here](https://aka.ms/gcm/httpproxy).
0 commit comments