mirror of
https://github.com/meteor/meteor.git
synced 2026-01-07 23:04:13 -05:00
More work on IssueTriage
This commit is contained in:
@@ -6,7 +6,7 @@ hard for the community to help you with your issue or pull request.
|
||||
We are excited to have your help building Meteor — both the platform and the
|
||||
community behind it. Here's how you can help with bug reports and new code.
|
||||
|
||||
## Reporting a bug in Meteor
|
||||
<h2 id="reporting-bug">Reporting a bug in Meteor</h2>
|
||||
|
||||
We welcome clear bug reports. If you've found a bug in Meteor that
|
||||
isn't a security risk, please file a report in
|
||||
@@ -56,7 +56,7 @@ better. We love getting bugfix pull requests. Just make sure they're
|
||||
written to the MDG style guide and *come with tests*. Read further down
|
||||
for more details on proposing changes to core code.
|
||||
|
||||
## Feature requests
|
||||
<h2 id="feature-requests">Feature requests</h2>
|
||||
|
||||
As of May 2016, we use GitHub to track feature requests. Feature request issues get the `feature` label, as well as a label
|
||||
corresponding to the Meteor subproject that they are a part of.
|
||||
|
||||
@@ -1,12 +1,54 @@
|
||||
# Issue Triage
|
||||
|
||||
This document describes the process Meteor contributors use to organize issues. We use Github [issues](https://github.com/meteor/meteor/issues) to track bugs and feature requests. Our goal is to maintain a list of issues that are relevant and well defined such that a contributor can immediately begin working on the code for a fix or feature request. Contributors who want to dive in and write code aren't likely to prioritize working issues that are ambiguous and have low impact.
|
||||
|
||||
We would love to have more contributors who are willing to help out with triaging issues. You can begin by helping issue requesters create good reproductions and by confirming those reproductions on your own machine. It won't be long before the core maintainers notice your work and ask whether you'd like to be promoted to an issue maintainer.
|
||||
|
||||
## Issue lifecycle
|
||||
|
||||
We use Github [issues](https://github.com/meteor/meteor/issues) to track bugs and feature requests. The following chart illustrates the process we use to triage an issue. The goal is to end up with bugs and feature requests
|
||||
that are well specced and un-ambigous - ready for contributors to begin working on.
|
||||
All issues follow the flow outlined below. Your job as an issue maintainer is to work with the requester and others within the community towards the goal of having an issue either become 'claimable' or closed. Read on for more details on the process.
|
||||
|
||||
[include flowchart]()
|
||||

|
||||
|
||||
The first step is in determining whether the issue is a bug, help question or feature request. Read on for more details.
|
||||
|
||||
### Bugs
|
||||
|
||||
1. Duplicates should be closed and marked as such.
|
||||
2. Bugs should have a high quality reproduction as described [here](Contributing.md#reporting-bug). You may need to help the reporter reduce their bug to a minimal reproduction.
|
||||
3. A reproduction should be confirmed by at least one person other than the original reporter. Run the reproduction and validate that the bug exists, make a note of your findings on the issue.
|
||||
4. Finally, [classify](#classification) the issue.
|
||||
|
||||
### Help questions
|
||||
|
||||
[Stack Overflow](http://stackoverflow.com/questions/tagged/meteor) and our [forums](https://forums.meteor.com/c/help) are the place to ask for help on using the framework. Close issues that are help requests and politely refer the author to the above locations.
|
||||
|
||||
### Feature requests
|
||||
|
||||
1. For reasons described [here](Contributing.md#feature-requests), we would prefer features to be built as separate packages. If the feature can clearly be built as a package, explain this to the requester and close the issue.
|
||||
2. If it's not possible to build the feature as a package, explore whether creating hooks in core would make it possible to do so. If the answer is yes, redefine the issue as such.
|
||||
3. Work with the requester and others in the community to build a clear specification for the feature and update the issue description accordingly.
|
||||
|
||||
<h2 id="classification">Classification</h2>
|
||||
|
||||
We assign a classification (e.g via GH labels) that enables the community to determine which issues are worth working on. The classification is based on *Severity x Impact x Effort*
|
||||
|
||||
#### Severity
|
||||
|
||||
- Is there a workaround?
|
||||
- Does it impact production apps or only development?
|
||||
|
||||
#### Impact
|
||||
|
||||
- What % of the community does this benefit? (ballpark)
|
||||
- Is the issue highly voted?
|
||||
|
||||
#### Effort (MDG internal)
|
||||
|
||||
- How much work is it to implement?
|
||||
|
||||
* Update title/description ?
|
||||
* Add labels - which?
|
||||
|
||||
|
||||
XXX!
|
||||
|
||||
BIN
IssueTriageFlow.png
Normal file
BIN
IssueTriageFlow.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 148 KiB |
Reference in New Issue
Block a user