1 Documentation guidelines

Igor Velikorossov редактировал(а) эту страницу 2020-03-10 10:22:58 +11:00

Содержание

• Q: What are xml-doc guidelines?
• Q: How breaking changes are documented?

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

Guidelines

• Interop guidelines
• Documentation guidelines

Build

• Dependencies
  • Adding an external dependency
• ARM64
  • Building for ARM64

Packaging

• Regenerate the ApiCompatBaseline file

How to...

• Building "old" commits