-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Add an issue template for API proposals #36335
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
eiriktsarpalis
wants to merge
4
commits into
dotnet:master
from
eiriktsarpalis:api-proposal-issue-template
Closed
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
1571970
Add an issue template for API proposals
eiriktsarpalis 744dfcc
Update .github/ISSUE_TEMPLATE/api-proposal.md
eiriktsarpalis 1273563
Update .github/ISSUE_TEMPLATE/api-proposal.md
eiriktsarpalis 493b695
Update .github/ISSUE_TEMPLATE/api-proposal.md
eiriktsarpalis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
eiriktsarpalis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ```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. | ||
eiriktsarpalis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| # Risks | ||
|
|
||
| Please mention any risks that to your knowledge the API proposal might entail, such as breaking changes, performance regressions, etc. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.