Skip to content

Commit 0030f43

Browse files
CopilotMalcolmnixon
andcommitted
Use meaningful names for markdown reference links
Replace generic link1, link2, etc. with descriptive names: - dotnet-tools, nuspec-reference, nuget-package-creation - github-issues, github-discussions, github-topics - releases, usage, building-from-source - dotnet-download, nuget-docs, github-flow - git-commit-guide, github-security, microsoft-sdl - owasp-secure-coding, github-security-advisories Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
1 parent 53b136f commit 0030f43

File tree

6 files changed

+52
-52
lines changed

6 files changed

+52
-52
lines changed

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This repository contains configuration and instructions for GitHub Copilot agent
55
## Repository Overview
66

77
**DotnetToolWrapper** is a .NET 8.0, 9.0, and 10.0 console application that serves as a wrapper for native
8-
applications packaged as [.NET Tools][link1].
8+
applications packaged as [.NET Tools][dotnet-tools].
99

1010
## Project Structure
1111

@@ -131,4 +131,4 @@ Before committing:
131131

132132
For questions or issues, please refer to the repository's issue tracker on GitHub.
133133

134-
[link1]: https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools
134+
[dotnet-tools]: https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools

ARCHITECTURE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This document describes the architecture and design of the DotnetToolWrapper pro
55
## Overview
66

77
DotnetToolWrapper is a .NET console application that serves as a universal launcher for native applications packaged
8-
as [.NET Tools][link1]. It enables developers to distribute
8+
as [.NET Tools][dotnet-tools]. It enables developers to distribute
99
platform-specific native executables through the .NET tool ecosystem.
1010

1111
## Problem Statement
@@ -172,4 +172,4 @@ The project uses GitHub Actions for CI/CD:
172172
- [CONTRIBUTING.md](CONTRIBUTING.md) - Contribution guidelines
173173
- [SECURITY.md](SECURITY.md) - Security policy
174174

175-
[link1]: https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools
175+
[dotnet-tools]: https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ We actively welcome pull requests! To submit a pull request:
5151

5252
### Prerequisites
5353

54-
- [.NET SDK 8.0 or higher][link1]
54+
- [.NET SDK 8.0 or higher][dotnet-download]
5555
- Git
5656
- A code editor (Visual Studio, Visual Studio Code, Rider, etc.)
5757

@@ -232,15 +232,15 @@ See [LICENSE](LICENSE) for details.
232232

233233
## Additional Resources
234234

235-
- [.NET Tool Documentation][link2]
236-
- [NuGet Package Documentation][link3]
237-
- [GitHub Flow][link4]
238-
- [Writing Good Commit Messages][link5]
235+
- [.NET Tool Documentation][dotnet-tools]
236+
- [NuGet Package Documentation][nuget-docs]
237+
- [GitHub Flow][github-flow]
238+
- [Writing Good Commit Messages][git-commit-guide]
239239

240240
Thank you for contributing to DotnetToolWrapper! 🎉
241241

242-
[link1]: https://dotnet.microsoft.com/download
243-
[link2]: https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools
244-
[link3]: https://learn.microsoft.com/en-us/nuget/
245-
[link4]: https://guides.github.com/introduction/flow/
246-
[link5]: https://chris.beams.io/posts/git-commit/
242+
[dotnet-download]: https://dotnet.microsoft.com/download
243+
[dotnet-tools]: https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools
244+
[nuget-docs]: https://learn.microsoft.com/en-us/nuget/
245+
[github-flow]: https://guides.github.com/introduction/flow/
246+
[git-commit-guide]: https://chris.beams.io/posts/git-commit/

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
![GitHub](https://img.shields.io/github/license/demaconsulting/DotnetToolWrapper?style=plastic)
77

88
A .NET console application that enables native executables to be distributed as
9-
[.NET Tools][link1].
9+
[.NET Tools][dotnet-tools].
1010

1111
## Overview
1212

@@ -34,7 +34,7 @@ dotnet tool install -g YourTool.Package
3434
your-tool --help
3535
```
3636

37-
Create your own wrapped tool by following the [Usage][link2] section below.
37+
Create your own wrapped tool by following the [Usage][usage] section below.
3838

3939
## Usage
4040

@@ -135,7 +135,7 @@ dotnet build --configuration Release
135135

136136
For real-world examples of tools using DotnetToolWrapper, see:
137137

138-
- Check the [GitHub topic][link3] for projects using this wrapper
138+
- Check the [GitHub topic][github-topics] for projects using this wrapper
139139

140140
## Contributing
141141

@@ -153,12 +153,12 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
153153

154154
## Support
155155

156-
- **Issues**: Report bugs or request features via [GitHub Issues][link4]
157-
- **Discussions**: Ask questions via [GitHub Discussions][link5]
156+
- **Issues**: Report bugs or request features via [GitHub Issues][github-issues]
157+
- **Discussions**: Ask questions via [GitHub Discussions][github-discussions]
158158
- **Security**: Report vulnerabilities per [SECURITY.md](SECURITY.md)
159159

160-
[link1]: https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools
161-
[link2]: #usage
162-
[link3]: https://github.com/topics/dotnettoolwrapper
163-
[link4]: https://github.com/demaconsulting/DotnetToolWrapper/issues
164-
[link5]: https://github.com/demaconsulting/DotnetToolWrapper/discussions
160+
[dotnet-tools]: https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools
161+
[usage]: #usage
162+
[github-topics]: https://github.com/topics/dotnettoolwrapper
163+
[github-issues]: https://github.com/demaconsulting/DotnetToolWrapper/issues
164+
[github-discussions]: https://github.com/demaconsulting/DotnetToolWrapper/discussions

SECURITY.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ report it to us as described below.
2222

2323
Instead, please report them via GitHub's private vulnerability reporting feature:
2424

25-
1. Navigate to the [Security tab][link1] of the repository
25+
1. Navigate to the [Security tab][github-security] of the repository
2626
2. Click "Report a vulnerability"
2727
3. Fill out the vulnerability report form with as much detail as possible
2828

@@ -175,9 +175,9 @@ For security-related questions that are not vulnerability reports:
175175

176176
This security policy is based on security best practices from:
177177

178-
- [Microsoft Security Development Lifecycle][link2]
179-
- [OWASP Secure Coding Practices][link3]
180-
- [GitHub Security Advisories][link4]
178+
- [Microsoft Security Development Lifecycle][microsoft-sdl]
179+
- [OWASP Secure Coding Practices][owasp-secure-coding]
180+
- [GitHub Security Advisories][github-security-advisories]
181181

182182
## Updates to This Policy
183183

@@ -189,7 +189,7 @@ We may update this security policy from time to time. We will notify users of ma
189189

190190
Last updated: December 2024
191191

192-
[link1]: https://github.com/demaconsulting/DotnetToolWrapper/security
193-
[link2]: https://www.microsoft.com/en-us/securityengineering/sdl/
194-
[link3]: https://owasp.org/www-project-secure-coding-practices-quick-reference-guide/
195-
[link4]: https://docs.github.com/en/code-security/security-advisories
192+
[github-security]: https://github.com/demaconsulting/DotnetToolWrapper/security
193+
[microsoft-sdl]: https://www.microsoft.com/en-us/securityengineering/sdl/
194+
[owasp-secure-coding]: https://owasp.org/www-project-secure-coding-practices-quick-reference-guide/
195+
[github-security-advisories]: https://docs.github.com/en/code-security/security-advisories

docs/usage.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Create a `.nuspec` file that defines your package metadata:
105105
- Include `<packageType name="DotnetTool" />` to mark this as a .NET tool
106106
- Adjust file paths in the `<files>` section to match your structure
107107

108-
Refer to the [.nuspec File Reference][link1] for more details.
108+
Refer to the [.nuspec File Reference][nuspec-reference] for more details.
109109

110110
### 2. Create DotnetToolSettings.xml
111111

@@ -191,8 +191,8 @@ into your `tools/{framework}/any/` folder:
191191

192192
You can obtain these files by:
193193

194-
1. Downloading from the [releases page][link2]
195-
2. Building from source (see [Building from Source][link3])
194+
1. Downloading from the [releases page][releases]
195+
2. Building from source (see [Building from Source][building-from-source])
196196

197197
### 5. Add Your Native Executables
198198

@@ -392,30 +392,30 @@ dotnet build --configuration Release
392392

393393
For real-world examples of tools using DotnetToolWrapper:
394394

395-
- Browse repositories on GitHub with the [dotnettoolwrapper topic][link4]
395+
- Browse repositories on GitHub with the [dotnettoolwrapper topic][github-topics]
396396
- Check the examples in the DotnetToolWrapper repository (if available)
397397

398398
## Support
399399

400-
- **Issues**: Report bugs or request features via [GitHub Issues][link5]
401-
- **Discussions**: Ask questions via [GitHub Discussions][link6]
400+
- **Issues**: Report bugs or request features via [GitHub Issues][github-issues]
401+
- **Discussions**: Ask questions via [GitHub Discussions][github-discussions]
402402
- **Documentation**: See [README.md](../README.md) for project overview
403403
- **Architecture**: See [ARCHITECTURE.md](../ARCHITECTURE.md) for design details
404404
- **Contributing**: See [CONTRIBUTING.md](../CONTRIBUTING.md) for contribution guidelines
405405

406406
## Additional Resources
407407

408-
- [.NET Tool Documentation][link7]
409-
- [.nuspec File Reference][link1]
410-
- [NuGet Package Creation][link8]
411-
- [NuGet CLI Reference][link9]
412-
413-
[link1]: https://learn.microsoft.com/en-us/nuget/reference/nuspec
414-
[link2]: https://github.com/demaconsulting/DotnetToolWrapper/releases
415-
[link3]: #building-from-source
416-
[link4]: https://github.com/topics/dotnettoolwrapper
417-
[link5]: https://github.com/demaconsulting/DotnetToolWrapper/issues
418-
[link6]: https://github.com/demaconsulting/DotnetToolWrapper/discussions
419-
[link7]: https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools
420-
[link8]: https://learn.microsoft.com/en-us/nuget/create-packages/creating-a-package
421-
[link9]: https://learn.microsoft.com/en-us/nuget/reference/nuget-exe-cli-reference
408+
- [.NET Tool Documentation][dotnet-tools]
409+
- [.nuspec File Reference][nuspec-reference]
410+
- [NuGet Package Creation][nuget-package-creation]
411+
- [NuGet CLI Reference][nuget-cli-reference]
412+
413+
[nuspec-reference]: https://learn.microsoft.com/en-us/nuget/reference/nuspec
414+
[releases]: https://github.com/demaconsulting/DotnetToolWrapper/releases
415+
[building-from-source]: #building-from-source
416+
[github-topics]: https://github.com/topics/dotnettoolwrapper
417+
[github-issues]: https://github.com/demaconsulting/DotnetToolWrapper/issues
418+
[github-discussions]: https://github.com/demaconsulting/DotnetToolWrapper/discussions
419+
[dotnet-tools]: https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools
420+
[nuget-package-creation]: https://learn.microsoft.com/en-us/nuget/create-packages/creating-a-package
421+
[nuget-cli-reference]: https://learn.microsoft.com/en-us/nuget/reference/nuget-exe-cli-reference

0 commit comments

Comments
 (0)