diff --git a/.github/ISSUE_TEMPLATE/api-proposal.md b/.github/ISSUE_TEMPLATE/api-proposal.md new file mode 100644 index 00000000000000..045d75670fc322 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/api-proposal.md @@ -0,0 +1,31 @@ +--- +name: API Proposal +about: Propose a change to the public API surface. +title: "[API Proposal] Your title goes here" +labels: api-suggestion +assignees: '' + +--- + +# Background and Motivation + +Please provide a thorough explanation of what necessitates the additional API. + +# Proposed API + +Please provide the precise public API signature diff that you are proposing. If augmenting existing API signatures this should be expressed using diff blocks, for example +```diff +namespace System.Collections.Generic +{ +- public class HashSet : ICollection, ISet { ++ public class HashSet : ICollection, ISet, IReadOnlySet { + } +``` + +# Usage Examples + +Please provide code examples that highlight how the proposed API additions are meant to be consumed. + +# Risks + +Please mention any risks that to your knowledge the API proposal might entail, such as breaking changes, performance regressions, etc.