Skip to content
Prev Previous commit
Next Next commit
Add an issue template for API proposals
  • Loading branch information
eiriktsarpalis committed May 14, 2020
commit fe998c647b574331b7b08c13dcb44d9625403ae9
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 might necessitate a change to the current APIs.

# Proposed API

Please provide the precise public API signature diff that you are proposing. If modifying 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 changes 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.