-
Notifications
You must be signed in to change notification settings - Fork 344
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from microsoft/mevey-patch-1
Update issue templates
- Loading branch information
Showing
4 changed files
with
453 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Discussion | ||
about: Start a discussion topic, or brainstorm a new idea, related to Project Reunion | ||
title: 'Discussion: [your title here] ' | ||
labels: discussion | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!-- This is a template for discussion issues. | ||
Discussion issues can be about any topics or ideas related to Project Reunion. | ||
For example, you might start a Discussion issue to see if others are interested in a cool new idea | ||
you've been thinking about that isn't quite ready to be filed as a more formal Feature Proposal. | ||
Discussion issues can also just be used to chat about non-feature-related topics, such as whether | ||
Project Reunion meets (or doesn't meet) your needs. | ||
--> | ||
|
||
# Discussion: [your title here] | ||
<!-- Add a title for your Discussion issue. Please be short and descriptive, and write body | ||
text in this section. --> | ||
|
||
## Related Links | ||
<!-- Please list any related links or references to this discussion issue --> |
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,66 @@ | ||
--- | ||
name: Feature Proposal | ||
about: Suggest a new feature or idea | ||
title: '' | ||
labels: feature proposal | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!-- This is a template for new feature or API proposals. | ||
For example you can use this to propose a new API on an existing type, or an idea for a new API. | ||
It's fine if you don't have all the details: you can start with the Summary and Rationale. | ||
--> | ||
|
||
# Proposal: [your title here] | ||
<!-- Add a title for your feature or API proposal. Please be short and descriptive --> | ||
|
||
## Summary | ||
<!-- Include 1-2 sentences summarizing your feature or API proposal --> | ||
|
||
## Rationale | ||
<!-- Create a list that describes WHY the feature should be added to Project Reunion for all | ||
developers and users. Proposals often have multiple motives for why we should do the work, | ||
so list each one as a separate bullet. | ||
If applicable you can also describe how the proposal aligns to the current Project Reunion roadmap | ||
and priorities in a separate paragraph: | ||
https://github.com/Microsoft/ProjectReunion/blob/master/docs/roadmap.md | ||
--> | ||
* {First reason for why we should consider this proposal} | ||
* {Second reason for why we should consider this proposal} | ||
* {etc} | ||
|
||
|
||
<!---------------------- | ||
The below sections are optional when submitting an idea or proposal. | ||
All sections are required before we'll accept a PR to master, but aren't necessary to start the discussion. | ||
------------------------> | ||
|
||
## Scope | ||
<!-- Please include a list of what the feature should and shouldn't do by filling in the table below. | ||
'Must' implies that the feature should not ship without this capability. | ||
'Should' is something we should push hard for, but is not absolutely required to ship. | ||
'Could' is a nice-to-have; a good stretch goal that isn't painful if we don't achieve it. | ||
'Won't' is a clear statement that the proposal/feature will intentionally not have that capability. | ||
This list will evolve and grow as the proposal becomes more refined over time. | ||
A good rule of thumb is to start your proposal with no more than 7 high-level requirements. | ||
--> | ||
| Capability | Priority | | ||
| :---------- | :------- | | ||
| This proposal will allow developers to accomplish W | Must | | ||
| This proposal will allow end users to accomplish X | Should | | ||
| This proposal will allow developers to accomplish Y | Could | | ||
| This proposal will allow end users to accomplish Z | Won't | | ||
|
||
## Important Notes | ||
<!-- Please include any other important details. | ||
This could include one or more of: | ||
- usage examples | ||
- an API proposal (any supported language or pseudocode is fine) | ||
- design mockups or example screenshots | ||
- other implementation notes | ||
--> | ||
|
||
## Open Questions | ||
<!-- Please list any open issues that you think still need to be addressed. | ||
These could include areas you think would benefit from community or Project Reunion team input --> |
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,10 @@ | ||
--- | ||
name: Question | ||
about: I have a question | ||
title: 'Question: [your question here]' | ||
labels: question | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!-- Use this section to give more context for your question or other supporting materials --> |
Oops, something went wrong.