Skip to content

Commit 28954c7

Browse files
Enhance documentation on updating reference source for new APIs (#120062)
Updated documentation to emphasize implementing API modifications and updating the reference source when adding new APIs. --------- Co-authored-by: Gerard Smit <gsmit1996@gmail.com>
1 parent 8614658 commit 28954c7

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/coding-guidelines/adding-api-guidelines.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ should be added to `net10.0`. [More Information on TargetFrameworks](https://lea
2929

3030
## Making the changes in repo
3131

32+
**Implement your API modification**
33+
- Implement your API modification in the appropriate library project.
34+
35+
**Update the reference source**
36+
- [Update the reference source](updating-ref-source.md) for the library.
37+
3238
**Update tests**
3339
- Add new `TargetFramework` to the ```TargetFrameworks```.
3440
- 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.

docs/workflow/building/libraries/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,4 +263,6 @@ If changes to the library include any API incompatibilities, calling `dotnet bui
263263

264264
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.
265265

266+
**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.
267+
266268
See https://learn.microsoft.com/dotnet/fundamentals/apicompat/overview for more details.

0 commit comments

Comments
 (0)