Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/api-proposal.md
Original file line number Diff line number Diff line change
@@ -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<T> : ICollection<T>, ISet<T> {
+ public class HashSet<T> : ICollection<T>, ISet<T>, IReadOnlySet<T> {
}
```

# 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.