Skip to content

Commit dbb8e41

Browse files
committed
Fix md lint errors that do not alter content
1 parent 25e9056 commit dbb8e41

13 files changed

+99
-90
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
## Contributing
1+
# Contributing
22

3-
[issue]: https://github.com/GitCredentialManager/git-credential-manager/issues
3+
[issue]: https://github.com/GitCredentialManager/git-credential-manager/issues
44
[fork]: https://github.com/GitCredentialManager/git-credential-manager/fork
55
[pr]: https://github.com/GitCredentialManager/git-credential-manager/compare
66
[code-of-conduct]: CODE_OF_CONDUCT.md
@@ -13,24 +13,24 @@ Please note that this project is released with a [Contributor Code of Conduct][c
1313

1414
## Start with an issue
1515

16-
0. Open an [issue][issue] to discuss the change you want to see.
16+
1. Open an [issue][issue] to discuss the change you want to see.
1717
This helps us coordinate and reduce duplication.
18-
0. Once we've had some discussion, you're ready to code!
18+
2. Once we've had some discussion, you're ready to code!
1919

2020
## Submitting a pull request
2121

22-
0. [Fork][fork] and clone the repository
23-
0. Configure and install the dependencies: `dotnet restore`
24-
0. Make sure the tests pass on your machine: `dotnet test`
25-
0. Create a new branch: `git switch -c my-branch-name`
26-
0. Make your change, add tests, and make sure the tests still pass
27-
0. For UI updates, test your changes by executing a `dotnet run` in applicable UI-related project directories:
22+
1. [Fork][fork] and clone the repository
23+
2. Configure and install the dependencies: `dotnet restore`
24+
3. Make sure the tests pass on your machine: `dotnet test`
25+
4. Create a new branch: `git switch -c my-branch-name`
26+
5. Make your change, add tests, and make sure the tests still pass
27+
6. For UI updates, test your changes by executing a `dotnet run` in applicable UI-related project directories:
2828
- `Atlassian.Bitbucket.UI.Avalonia`
2929
- `GitHub.UI.Avalonia`
3030
- `Atlassian.Bitbucket.UI.Windows`
3131
- `GitHub.UI.Windows`
32-
0. Push to your fork and [submit a pull request][pr]
33-
0. Pat your self on the back and wait for your pull request to be reviewed and merged.
32+
7. Push to your fork and [submit a pull request][pr]
33+
8. Pat your self on the back and wait for your pull request to be reviewed and merged.
3434

3535
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
3636

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -97,24 +97,24 @@ run the following:
9797

9898
1. To ensure `curl` is installed:
9999

100-
```shell
101-
curl --version
102-
```
100+
```shell
101+
curl --version
102+
```
103103

104-
If `curl` is not installed, please use your distribution's package manager
105-
to install it.
104+
If `curl` is not installed, please use your distribution's package manager
105+
to install it.
106106

107-
0. To download and run the script:
107+
2. To download and run the script:
108108

109-
```shell
110-
curl -LO https://raw.githubusercontent.com/GitCredentialManager/git-credential-manager/main/src/linux/Packaging.Linux/install-from-source.sh &&
111-
sh ./install-from-source.sh &&
112-
git-credential-manager-core configure
113-
```
109+
```shell
110+
curl -LO https://raw.githubusercontent.com/GitCredentialManager/git-credential-manager/main/src/linux/Packaging.Linux/install-from-source.sh &&
111+
sh ./install-from-source.sh &&
112+
git-credential-manager-core configure
113+
```
114114

115-
__Note:__ You will be prompted to enter your credentials so that the script
116-
can download GCM's dependencies using your distribution's package
117-
manager.
115+
**Note:** You will be prompted to enter your credentials so that the script
116+
can download GCM's dependencies using your distribution's package
117+
manager.
118118

119119
#### Ubuntu/Debian distributions
120120

@@ -124,7 +124,8 @@ Download the latest [.deb package](https://github.com/GitCredentialManager/git-c
124124
sudo dpkg -i <path-to-package>
125125
git-credential-manager-core configure
126126
```
127-
__Note:__ Although packages were previously offered on certain
127+
128+
**Note:** Although packages were previously offered on certain
128129
[Microsoft Ubuntu package feeds](https://packages.microsoft.com/repos/),
129130
GCM no longer publishes to these repositories. Please install the
130131
Debian package using the above instructions instead.
@@ -249,7 +250,7 @@ See detailed information [here](https://aka.ms/gcm/httpproxy).
249250

250251
## Contributing
251252

252-
This project welcomes contributions and suggestions.
253+
This project welcomes contributions and suggestions.
253254
See the [contributing guide](CONTRIBUTING.md) to get started.
254255

255256
This project follows [GitHub's Open Source Code of Conduct](CODE_OF_CONDUCT.md).

SECURITY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Security
2+
13
If you discover a security issue in this repo, please submit it through the [GitHub Security Bug Bounty](https://hackerone.com/github)
24

35
Thanks for helping make GitHub products safe for everyone.

docs/bitbucket-development.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,18 +65,18 @@ The Access and Refresh Tokens will be stored against the username and the userna
6565

6666
# On-Premise Bitbucket
6767

68-
On-premise Bitbucket, more correctly known as Bitbucket Server or Bitbucket DC, has a number of differences compared to the cloud instance of Bitbucket, https://bitbucket.org.
68+
On-premise Bitbucket, more correctly known as Bitbucket Server or Bitbucket DC, has a number of differences compared to the cloud instance of Bitbucket, https://bitbucket.org.
6969

7070
As far as GCMC is concerned the main difference it doesn't support OAuth so only Basic Authentication is available.
7171

7272
It is possible to test with Bitbucket Server by running it locally using the following command from the Atlassian SDK:
7373

74-
❯ atlas-run-standalone --product bitbucket
74+
❯ atlas-run-standalone --product bitbucket
7575

7676
See https://developer.atlassian.com/server/framework/atlassian-sdk/atlas-run-standalone/.
7777

7878
This will download and run a standalone instance of Bitbucket Server which can be accessed using the credentials `admin`/`admin` at
7979

80-
https://localhost:7990/bitbucket
80+
https://localhost:7990/bitbucket
8181

8282
Instructions on how to download and install the Atlassian SDK can be found here: https://developer.atlassian.com/server/framework/atlassian-sdk/

docs/configuration.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,6 @@ git config --global credential.httpsProxy http://john.doe:[email protected]
196196
Override the available authentication modes presented during Bitbucket authentication.
197197
If this option is not set, then the available authentication modes will be automatically detected.
198198

199-
200199
**Note:** This setting only applies to Bitbucket.org, and not Server or DC instances.
201200

202201
**Note:** This setting supports multiple values separated by commas.
@@ -227,7 +226,6 @@ Enabling this option will improve performance when using Oauth2 and interacting
227226

228227
Enabling this option will decrease performance when using Basic Auth by requiring the user the re-enter credentials everytime.
229228

230-
231229
Value|Refresh Credentials Before Returning
232230
-|-
233231
`true`, `1`, `yes`, `on` |Always
@@ -295,7 +293,6 @@ git config --global credential.gitLabAuthModes "browser"
295293

296294
---
297295

298-
299296
### credential.namespace
300297

301298
Use a custom namespace prefix for credentials read and written in the OS credential store.
@@ -332,7 +329,7 @@ _(unset)_|Windows: `wincredman`<br/>macOS: `keychain`<br/>Linux: _(none)_|-
332329
`cache`|Git's built-in [credential cache](https://git-scm.com/docs/git-credential-cache).|Windows, macOS, Linux
333330
`plaintext`|Store credentials in plaintext files (**UNSECURE**). Customize the plaintext store location with [`credential.plaintextStorePath`](#credentialplaintextstorepath).|Windows, macOS, Linux
334331

335-
##### Example
332+
#### Example
336333

337334
```bash
338335
git config --global credential.credentialStore gpg
@@ -475,6 +472,7 @@ Credential: "git:https://github.com" (user = alice)
475472
https://github.com/contoso/widgets
476473
https://[email protected]/contoso/widgets
477474
```
475+
478476
```text
479477
Credential: "git:https://[email protected]" (user = bob)
480478
@@ -489,17 +487,20 @@ Credential: "git:https://github.com/foo/bar" (user = alice)
489487
490488
https://github.com/foo/bar
491489
```
490+
492491
```text
493492
Credential: "git:https://github.com/contoso/widgets" (user = alice)
494493
495494
https://github.com/contoso/widgets
496495
https://[email protected]/contoso/widgets
497496
```
497+
498498
```text
499499
Credential: "git:https://[email protected]/foo/bar" (user = bob)
500500
501501
https://[email protected]/foo/bar
502502
```
503+
503504
```text
504505
Credential: "git:https://[email protected]/example/myrepo" (user = bob)
505506

docs/development.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ $ dotnet test --collect:"XPlat Code Coverage" --settings=./.code-coverage/coverl
106106

107107
Or via the VSCode Terminal/Run Task:
108108

109-
```
109+
```console
110110
test with coverage
111111
```
112112

@@ -115,6 +115,7 @@ HTML reports can be generated using ReportGenerator, this should be installed du
115115
```shell
116116
$ dotnet ~/.nuget/packages/reportgenerator/*/*/net6.0/ReportGenerator.dll -reports:./**/TestResults/**/coverage.cobertura.xml -targetdir:./out/code-coverage
117117
```
118+
118119
or
119120

120121
```shell
@@ -123,12 +124,12 @@ $ dotnet {$env:USERPROFILE}/.nuget/packages/reportgenerator/*/*/net6.0/ReportGen
123124

124125
Or via VSCode Terminal/Run Task:
125126

126-
```
127+
```console
127128
report coverage - nix
128129
```
129130

130131
or
131132

132-
```
133+
```console
133134
report coverage - win
134-
```
135+
```

docs/enterprise-config.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The addition of the enterprise system administrator defaults enables those
1818
administrators to configure many GCM settings using familiar MDM tooling, rather
1919
than having to modify the Git installation configuration files.
2020

21-
### User Freedom
21+
## User Freedom
2222

2323
We believe the user should _always_ be at liberty to configure
2424
Git and GCM exactly as they wish. By prefering environment variables and Git
@@ -30,13 +30,13 @@ that can always be overriden by the user in the usual ways.
3030
Default setting values come from the Windows Registry, specifically the
3131
following keys:
3232

33-
**32-bit Windows**
33+
### 32-bit Windows
3434

3535
```text
3636
HKEY_LOCAL_MACHINE\SOFTWARE\GitCredentialManager\Configuration
3737
```
3838

39-
**64-bit Windows**
39+
### 64-bit Windows
4040

4141
```text
4242
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\GitCredentialManager\Configuration
@@ -55,7 +55,6 @@ those of the [Git configuration](configuration.md) settings.
5555
The type of each registry key can be either `REG_SZ` (string) or `REG_DWORD`
5656
(integer).
5757

58-
5958
## macOS/Linux
6059

6160
Default configuration setting stores has not been implemented.

0 commit comments

Comments
 (0)