Enhance documentation on updating reference source for new APIs#120062
Enhance documentation on updating reference source for new APIs#120062jkotas merged 3 commits intodotnet:mainfrom
Conversation
Updated documentation to emphasize implementing API modifications and updating the reference source when adding new APIs.
There was a problem hiding this comment.
Pull Request Overview
This PR enhances documentation to provide clearer guidance on updating reference source when adding new APIs to the dotnet/runtime repository. The changes emphasize the importance of implementing API modifications and updating reference source rather than suppressing compatibility errors.
Key changes:
- Added explicit guidance in the libraries build documentation about updating reference source for new APIs
- Enhanced the API adding guidelines with step-by-step instructions for implementing API modifications
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/workflow/building/libraries/README.md | Added note clarifying that new APIs require reference source updates instead of suppressing compatibility errors |
| docs/coding-guidelines/adding-api-guidelines.md | Added structured steps for implementing API modifications and updating reference source |
github-actions
bot
added
the
needs-area-label
dotnet-policy-service
bot
added
the
community-contribution
jkotas
added
area-Infrastructure-libraries
and removed
needs-area-label
|
Tagging subscribers to this area: @dotnet/area-infrastructure-libraries |
GerardSmit
left a comment
GerardSmit
left a comment
There was a problem hiding this comment.
Shouldn't these be relative paths instead of URLs?
Co-authored-by: Gerard Smit <gsmit1996@gmail.com>
Co-authored-by: Gerard Smit <gsmit1996@gmail.com>
Oops! Right. Thanks for the reminder. |
|
/ba-g docs only change |
3 participants
Updated documentation to emphasize implementing API modifications and updating the reference source when adding new APIs, in response to the discussion here.