Skip to content

Update Patch Guidelines #5411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MichaelSimons merged 1 commit into from
Nov 10, 2025
Merged

Update Patch Guidelines #5411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/linters/.linkspector.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ dirs:
excludedDirs:
- eng/readme-templates
ignorePatterns:
- pattern: "^https://github.com/dotnet/sdk/tree/main/src/SourceBuild/patches"
- pattern: "^https://dotnetcli.blob.core.windows.net/source-built-artifacts/sdks/"
- pattern: "^https://dotnetcli.blob.core.windows.net/source-built-artifacts/assets/"
- pattern: "^https://www.reddit.com/r/archlinux/comments/cx64r5/the_state_of_net_core_on_arch/"
Expand Down
20 changes: 8 additions & 12 deletions Documentation/patching-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ ephemeral until the repo fixes flow in.

This document provides guidance for creating and managing source build patches.

**NOTE:** Starting with 10.0, the [Unified Build](https://github.com/dotnet/dotnet/blob/main/docs/README.md)
project added support for source edits in the [VMR](https://github.com/dotnet/dotnet).
This has eliminated the need for patches as the required changes can be directly made in the VMR.
All changes made to the VMR will automatically backflow to the associated repos.

## Creating Patches

To create a repo patch file, first commit your changes to the source repo (e.g.
Expand All @@ -24,10 +29,10 @@ git format-patch --zero-commit --no-signature -1
Then, move the patch file into the `src/SourceBuild/patches/<repo>` directory of
the following repo:

* [.NET 9.0+]
[sdk](https://github.com/dotnet/sdk/tree/main/src/SourceBuild/patches)
* [.NET 9.0]
[sdk](https://github.com/dotnet/sdk/tree/release/9.0.1xx)
* [.NET 8.0]
[installer](https://github.com/dotnet/installer/tree/main/src/SourceBuild/patches)
[installer](https://github.com/dotnet/installer/tree/release/8.0.1xx)

If an existing directory for the repo does not already exist, you will need to
create one.
Expand Down Expand Up @@ -109,12 +114,3 @@ to be deleted.
1. The code being changed or surrounding code was changed - when this happens,
the patch will need to be updated. This can be done by manually updating the
patch or by re-applying the changes to the repo and recreating the patch.

## Unified Build Plans

The [Unified
Build](https://github.com/dotnet/dotnet/blob/main/docs/README.md)
project will add support for source edits in the
[VMR](https://github.com/dotnet/dotnet). This will eliminate the need for
patches as the required changes can be directly made in the VMR. All changes
made to the VMR will automatically flow to the associated repos.