Browse Source

doc: markdownlint (#12389)

Add .markdownlint config with exclusions and fix obvious style.
html and generated pages ignored

update versions for latest version in README

add VS Code default solution
pull/12390/head
Gerhard Olsson 2 months ago
committed by GitHub
parent
commit
23173e03a0
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 12
      .github/PULL_REQUEST_TEMPLATE.md
  2. 7
      .github/copilot-instructions.md
  3. 4
      .markdownlint.json
  4. 3
      .vscode/settings.json
  5. 6
      CODE_OF_CONDUCT.md
  6. 1
      CONTRIBUTING.md
  7. 6
      README.md
  8. 4
      setup/assets/Logo/README.md
  9. 6
      setup/assets/PrivacyPolicy.md
  10. 3
      setup/installer/README.md

12
.github/PULL_REQUEST_TEMPLATE.md

@ -4,9 +4,9 @@ Fixes #
## Proposed changes
-
-
-
-
-
-
## Screenshots <!-- Include variants with higher scaling, e.g. 150% or 200%. Remove this section if PR does not change UI -->
@ -20,9 +20,9 @@ Fixes #
## Test methodology <!-- How did you ensure quality? -->
-
-
-
-
-
-
## Test environment(s) <!-- Remove any that don't apply -->

7
.github/copilot-instructions.md

@ -1,6 +1,6 @@
# Instructions for GitHub and VisualStudio Copilot
### https://github.blog/changelog/2025-01-21-custom-repository-instructions-are-now-available-for-copilot-on-github-com-public-preview/
<https://github.blog/changelog/2025-01-21-custom-repository-instructions-are-now-available-for-copilot-on-github-com-public-preview/>
## General
@ -17,9 +17,9 @@
* Use pattern matching and switch expressions wherever possible.
* Use `nameof` instead of string literals when referring to member names.
### **Variable Declarations:**
### Variable Declarations
* Never use `var` for primitive types. Use `var` only when the type is obvious from context. When in doubt, opt for an explicit type declaration.
* Never use `var` for primitive types. Use `var` only when the type is obvious from context. When in doubt, opt for an explicit type declaration.
* Prefer simplified "new()" construct over to "new MyType()" where the type is already declared.
For example: "MyType t = new()" instead of "var t = new MyType()" or "MyType t = new MyType()".
@ -29,7 +29,6 @@
* Always use `is null` or `is not null` instead of `== null` or `!= null`.
* Trust the C# null annotations and don't add null checks when the type system says a value cannot be null.
### Testing
* We use NUnit SDK

4
.markdownlint.json

@ -0,0 +1,4 @@
{
"MD013": false,
"MD041": false
}

3
.vscode/settings.json

@ -0,0 +1,3 @@
{
"dotnet.defaultSolution": "GitExtensions.sln"
}

6
CODE_OF_CONDUCT.md

@ -58,7 +58,7 @@ further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at gitextensions@outlook.com.
reported by contacting the project team at <gitextensions@outlook.com>.
Alternatively you may reach out to individual maintainers via their profile email,
Twitter handle or LinkedIn messaging, as available and convenient. All
complaints will be reviewed and investigated and will result in a response that
@ -73,9 +73,9 @@ members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
<https://www.contributor-covenant.org/faq>

1
CONTRIBUTING.md

@ -63,4 +63,3 @@ and to perform additional work on the changes in response to review feedback.
## Conduct
Please review our [code of conduct](CODE_OF_CONDUCT.md).

6
README.md

@ -27,7 +27,7 @@ Have a question? Come and talk to us: [![Gitter](https://badges.gitter.im/Join%2
Runtime environment
</td>
<td>
MS Windows 7SP1+ // <a href="https://dotnet.microsoft.com/download/dotnet/8.0" target=_blank>.NET 8.0 SDK</a>
MS Windows 7SP1+ // <a href="https://dotnet.microsoft.com/download/dotnet/9.0" target=_blank>.NET 9.0 SDK</a>
</td>
</tr>
<tr>
@ -35,7 +35,7 @@ Have a question? Come and talk to us: [![Gitter](https://badges.gitter.im/Join%2
Development
</td>
<td>
MS Visual Studio 2022 (v17.8+), C# 12 // VC++ (inc. ATL for x86/x64 for installer)
MS Visual Studio 2022 (v17.12+), C# 13 // VC++ (inc. ATL for x86/x64 for installer)
</td>
</tr>
<tr>
@ -60,7 +60,6 @@ Have a question? Come and talk to us: [![Gitter](https://badges.gitter.im/Join%2
See [build instructions](https://github.com/gitextensions/gitextensions/wiki/Build-instructions)
## Downloads
<a href="https://github.com/gitextensions/gitextensions/releases" rel="nofollow" style="vertical-align: -webkit-baseline-middle;"><img src="https://img.shields.io/github/downloads/gitextensions/gitextensions/total.svg?label=GitHub%20downloads%20(total)&cacheSeconds=86400"></a> <a href="https://chocolatey.org/packages/gitextensions" rel="nofollow" style="vertical-align: -webkit-baseline-middle;"><img src="https://img.shields.io/chocolatey/dt/gitextensions.svg?label=Chocolatey%20downloads%20(total)&cacheSeconds=86400"></a>
@ -180,7 +179,6 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
<a href="https://opencollective.com/gitextensions/sponsor/8/website" target="_blank"><img src="https://opencollective.com/gitextensions/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/gitextensions/sponsor/9/website" target="_blank"><img src="https://opencollective.com/gitextensions/sponsor/9/avatar.svg"></a>
# Useful Links
* Website: [gitextensions.github.io](https://gitextensions.github.io/) [Git repo](https://github.com/gitextensions/gitextensions.github.io)

4
setup/assets/Logo/README.md

@ -1,3 +1,3 @@
This folder contains optimised renders of the Git Extensions logo.
This folder contains optimized renders of the Git Extensions logo.
The original SVG file from which the icons were rendered is in the `Artwork` folder.
The original SVG file from which the icons were rendered is in the `Artwork` folder.

6
setup/assets/PrivacyPolicy.md

@ -8,9 +8,10 @@ First, a reminder: Git Extensions is provided "as is", without warranty of any k
For telemetry we employ [Microsoft Application Insights](https://docs.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview). The information is collected on rolling basis, and is stored for a limited amount of time.
Here's a breakdown of all the information we may collect via the Application Insights.
### Application-Level
Includes:
* Exception information (could, in rare cases, contain paths on your computer)
* App version number (e.g. 2.0.x.x)
* Is portable version
@ -21,9 +22,10 @@ Includes:
* SSH client (e.g. OpenSSH or PuTTY)
* SSH client path (e.g. C:\Program Files (x86)\GitExtensions\PuTTY\plink.exe)
### Operating System-Level
Includes:
* OS version (e.g. Windows 10.0.17763.0)
* .NET CLR version (e.g. 4.0.30319.42000)
* .NET SDK version (e.g. dotnet:2.10.0-24102)

3
setup/installer/README.md

@ -1,4 +1,3 @@
Building installers for Git Extensions
======================================
## Building installers for Git Extensions
See the [wiki](https://github.com/gitextensions/gitextensions/wiki/Build-instructions).
Loading…
Cancel
Save