-
Notifications
You must be signed in to change notification settings - Fork 13
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
Add a proposal template #47
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 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
This file contains 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,41 @@ | ||
# Proposal name | ||
|
||
**Author**: Name here | ||
|
||
**Status**: Draft | ||
|
||
**Created**: Date here | ||
|
||
**Last updated**: Date here | ||
justinfagnani marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# Summary | ||
|
||
A brief, one or two sentence explanation of the proposal. | ||
|
||
# Example | ||
|
||
Provide an example of the API using type definitions and/or code example. | ||
|
||
# Goals | ||
|
||
- Write an explicit list. | ||
- Of what this proposal hopes to achieve. | ||
- Be as specific and broad as possible. | ||
|
||
# Non-goals | ||
|
||
- It's also important to be explicit about non-goals. | ||
- This prevents feature creep and tangent conversations. | ||
- Both goals and non-goals are valid topics to debate and can make/break the proposal. | ||
|
||
# Design detail | ||
|
||
Go into detail on the design of the API, This is where you go past the surface and explain the mechanics of how the API works. If a step-by-step direction is possible, provide it. | ||
|
||
# Open questions | ||
|
||
The first draft of any proposal is not going to have all of the answers. Take this space to be clear of what is still unknown. | ||
|
||
# Previous considerations | ||
|
||
List any previous proposals or priority art that inspired this proposal. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some minor copyedits.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you submit this as a new PR? Looks like it was merged before these could be accepted.