Documentation guidelines

Jump to bottom

Igor Velikorossov edited this page Mar 9, 2020 · 1 revision

Q: What are xml-doc guidelines?

A: Please refer to https://github.com/dotnet/dotnet-api-docs/wiki

Q: How breaking changes are documented?

A: Any PRs that contain (potentially) breaking changes must be labelled with documentation: breaking label.
Furthermore all breaking changes must be documented via https://github.com/dotnet/docs/issues/new?template=doc-breaking-change.md