VSadov/Satori
1
0
Fork 0
mirror of https://github.com/VSadov/Satori.git synced 2025-06-08 03:27:04 +09:00
Code Activity

Organize some markdowns and fix links (#1159)

Browse source 
* Move files into hierarchy

* fix more links

* Fix botr and features links

* Remove bad apostrophe

* spelling

* Apply suggestions from code review

Co-Authored-By: Youssef Victor <31348972+Youssef1313@users.noreply.github.com>

* Update docs/coding-guidelines/package-projects.md

Co-Authored-By: Jan Kotas <jkotas@microsoft.com>

Co-authored-by: Youssef Victor <31348972+Youssef1313@users.noreply.github.com>
Co-authored-by: Jan Kotas <jkotas@microsoft.com>
This commit is contained in:
Dan Moseley 2019-12-26 15:22:57 -08:00 • committed by GitHub
parent a2faf10b6c
commit 9900dfb4b2
Signed by: github
GPG key ID: 4AEE18F83AFDEB23
54 changed files with 102 additions and 95 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/coding-guidelines/adding-api-guidelines.md
View file

@ -4,17 +4,16 @@ Recommended reading to better understand this document:
| [Package-Projects](package-projects.md)
# Add APIs
- [Determining versions and targets](#determining-versions-and-targets)
- [Making the changes in repo](#making-the-changes-in-repo)
- [FAQ](#faq)
## Determining versions and targets
1. [Determine what library](#determine-what-library) the API goes into.
2. [Determine the target framework](#determine-target-framework) for the library that will contain the API.
3. [Determine the version](#determine-library-version) for the library that will contain the API.
- [Add APIs](#add-apis)
- [Determine what library](#determine-what-library)
- [Determine target framework](#determine-target-framework)
- [Determine library version](#determine-library-version)
- [Making the changes in repo](#making-the-changes-in-repo)
- [FAQ](#faq)
### Determine what library
- Propose a library for exposing it as part of the [API review process](http://aka.ms/apireview).
- Keep in mind the API might be exposed in a reference assembly that
doesn't match the identity of the implementation. There are many reasons for this but
@ -23,9 +22,10 @@ different platforms while sharing a common API surface and allowing us to refact
the implementation without compat concerns in future releases.
### Determine target framework
`netstandard` or `netcoreapp` is the target framework version currently under development.
- If the library is [part of netstandard](#isnetstandard)
- If the library is [part of netstandard](#faq)
- Your target framework should be `netstandard`
- If it is a new API only available on .NET Core then it will be added to `netcoreapp`
- If the library is not part of netstandard
@ -83,4 +83,4 @@ project references across the projects. You also need to be sure to leave type-f
where you removed types in order to maintain back-compat.
[net-standard table]: https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support
[net-standard table]: https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support