Skip to content
This repository has been archived by the owner on Jul 15, 2023. It is now read-only.

Latest commit

 

History

History

RecommendedChanges

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Microsoft.Win32
Microsoft.Win32
 
 
System.Collections.Generic
System.Collections.Generic
 
 
System.Collections
System.Collections
 
 
System.ComponentModel
System.ComponentModel
 
 
System.Configuration.Provider
System.Configuration.Provider
 
 
System.Configuration
System.Configuration
 
 
System.Diagnostics.Eventing
System.Diagnostics.Eventing
 
 
System.Diagnostics
System.Diagnostics
 
 
System.Globalization
System.Globalization
 
 
System.IO.Pipes
System.IO.Pipes
 
 
System.IO
System.IO
 
 
System.Linq.Expressions
System.Linq.Expressions
 
 
System.Net.Cache
System.Net.Cache
 
 
System.Net.Security
System.Net.Security
 
 
System.Net.Sockets
System.Net.Sockets
 
 
System.Net
System.Net
 
 
System.Reflection
System.Reflection
 
 
System.Resources
System.Resources
 
 
System.Runtime.CompilerServices
System.Runtime.CompilerServices
 
 
System.Runtime.ConstrainedExecution
System.Runtime.ConstrainedExecution
 
 
System.Runtime.InteropServices
System.Runtime.InteropServices
 
 
System.Runtime.Remoting.Messaging
System.Runtime.Remoting.Messaging
 
 
System.Runtime.Remoting.Proxies
System.Runtime.Remoting.Proxies
 
 
System.Runtime.Remoting
System.Runtime.Remoting
 
 
System.Runtime.Serialization
System.Runtime.Serialization
 
 
System.Security.Cryptography.X509Certificates
System.Security.Cryptography.X509Certificates
 
 
System.Security.Cryptography
System.Security.Cryptography
 
 
System.Security.Permissions
System.Security.Permissions
 
 
System.Security
System.Security
 
 
System.Text
System.Text
 
 
System.Threading.Tasks
System.Threading.Tasks
 
 
System.Threading
System.Threading
 
 
System.Timers
System.Timers
 
 
System.Web.Script.Serialization
System.Web.Script.Serialization
 
 
System.Web
System.Web
 
 
System.Xml.Schema
System.Xml.Schema
 
 
System.Xml
System.Xml
 
 
System
System
 
 
! Template.md
! Template.md
 
 
README.md
README.md
 
 

README.md

Introduction

These are recommended actions to take for APIs that are not supported on a .NET platform. The .NET Portability Analyzer consumes these as they are updated, so the latest recommendations are used.

Adding Recommendations

  1. Copy the template: ! Template.md
  2. Fill in a Twitter-sized Recommended Action
  3. Fill in "Affected APIs"
    1. Find the highest level that your recommended action affects and use that docId
    2. Find docIds using:
  4. Place the file in the following folder structure: namespace => recommended_action.md
  5. Create a pull request!

Example

I have a recommended change for the class System.Threading.Thread. My change could look like this:

Full Path: docs/RecommendedChanges/System.Threading/Use Task library.md

Content:

### Recommended Action
Use Task library instead.
### Affected APIs
* `T:System.Threading.Thread`

Updating Recommendations

  1. Find the namespace of the recommendation you want to update
  2. Locate the folder with that namespace under docs/RecommendedChanges
  3. Find the .md file with the recommendation
  4. Update the contents
  5. Create a pull request!

Note

The .NET Portability Service is aware of the hierarchy of APIs. First, it looks for a recommended change containing that exact docId, then it searches the ancestors of that docId until it reaches the first recommended change or the namespace level.

Document Comment Identifiers (docId)

Each API is represented as an ID string that is constructed using the guidelines specified in Processing the XML File. Microsoft.Fx.Portability.MetadataReader decodes docIds using this specification (ie. DependencyFinderEngineHelper.cs)