microsoft / microsoft/DirectXShaderCompiler

[Feature Request] Add info for the Winget package.

Open Beginner friendly
#8,025 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C++
Stars
3.7k
Forks
900
Avg merge
2d 11h
Merged PRs (30d)
44

Description

Is your feature request related to a problem? Please describe.
I've added a Winget package for DirectX Shader Compiler (https://github.com/microsoft/winget-pkgs/pull/325910, and since Winget is also a Microsoft tool (like what Nuget is), I presume that info on that package should be added to the listed available installation methods in this repo.

Describe the solution you'd like
Presumably that mentions of the Winget installation method gets listed in the Releases notes, like what the Nuget methods are.

For the newest version at the time of writing, this would likely mean replacing:
"This DX compiler release is also available as a NuGet package Microsoft.Direct3D.DXC."

With:
"This DX compiler release is also available as a NuGet package Microsoft.Direct3D.DXC, and as a Winget package Microsoft.DirectX.ShaderCompiler."

Describe alternatives you've considered
That mentions of Winget, Nuget, binary, and other (if any) installation methods get added to the README.md.

Winget packages are unfortunately not inherently auto-updated when new binaries are released on GitHub, but there's at least a few people on the Winget-pkgs repo to ask for help on adding it to their auto-update bots or about other ways of auto-updating.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the release notes and README.md sections that describe available installation methods, then compare their existing NuGet wording with the requested Winget package information. Done means the relevant documentation consistently mentions the Microsoft.DirectX.ShaderCompiler Winget package and preserves the package links and release-specific wording.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, release
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.