Skip to content

Enhance documentation on updating reference source for new APIs #120062

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
jkotas merged 3 commits into from
Sep 25, 2025
Merged

Enhance documentation on updating reference source for new APIs #120062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b4b5eb1
Enhance documentation on updating reference source for new APIs
SadPencil Sep 24, 2025
eec33ea
Apply suggestion from @GerardSmit
SadPencil Sep 24, 2025
8a30806
Apply suggestion from @GerardSmit
SadPencil Sep 24, 2025
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
6 changes: 6 additions & 0 deletions docs/coding-guidelines/adding-api-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ should be added to `net10.0`. [More Information on TargetFrameworks](https://lea

## Making the changes in repo

**Implement your API modification**
- Implement your API modification in the appropriate library project.

**Update the reference source**
- [Update the reference source](updating-ref-source.md) for the library.

**Update tests**
- Add new `TargetFramework` to the ```TargetFrameworks```.
- Add new test code following [conventions](project-guidelines.md#code-file-naming-conventions) for new files to that are specific to the new target framework.
Expand Down
2 changes: 2 additions & 0 deletions docs/workflow/building/libraries/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,4 +263,6 @@ If changes to the library include any API incompatibilities, calling `dotnet bui

In rare cases where these are expected (e.g. updating APIs previously shipped only in preview or as experimental), the errors may be suppressed. This can be done by following the directions in the error to invoke `dotnet build` (if the project isn't packable) or `dotnet pack` (if the project is packable) with an additional `/p:ApiCompatGenerateSuppressionFile=true` argument.

**Note:** If you are simply adding new APIs, you should not suppress API compatibility errors. Instead, make sure you have updated [the reference source](../../../coding-guidelines/updating-ref-source.md) for the library.

See https://learn.microsoft.com/dotnet/fundamentals/apicompat/overview for more details.