-
Notifications
You must be signed in to change notification settings - Fork 267
Submitting and working with issues
We use github issues for all issue tracking, with a combination of milestones and tagging organizing things. The milestones line up with our roadmap, so not all bugs will have a milestone attached.
##Tags
-
priority (1 - 4)
Every bug should be assigned a single priority, which should be used to measure the severity of an issue within it's milestone. Issues without milestones are given a best guess priority that can be used to comb through all the "coming later" issues against their importance right now to the project. -
type (multiple)
Each issue should be given a single type. If an issue touches multiple types, it's assigned to the type it feels most a part of. Not precise science, but these are meant as filters. -
bug
This is for something that is broken against the intended behavior, generally something that's crept through tests and been discovered after it was once working. -
critical
Something that cannot slip to another milestone. Critical issues should delay any release and be fixed before the release is considered final. -
first commit
A filter for issues that would make a good starting point for new developers. Doesn't mean stay away, but we should tag things that are easy-ish fixes as a way to welcome new people. -
pending review
This tag should be applied to all newly submitted issues so we can review incoming issues, provide context, and verify them before assigning them to a milestone.
##Submitting a new issue Anyone can submit a new issue if they find a bug in the platform, and it's easy. Just go here and fill out the form. Please be as detailed as possible and report as much specific information and context as possible. We're looking for things like:
- error messages (if something's broken)
- browser and version (if it's a javascript/markup issue)
- PHP version and information (for PHP issues)
- expected behavior and what actually happened
- details and links if possible
- your thinking behind new feature requests
- etc
When you submit a new issue we ask that you tag it as pending review — you can also feel free to assign a type and/or mark it as a bug but please don't bother with priority or critical as we'll assign those in the context of the full platform roadmap.
##Final note
All issue and bug reports help us. Some will get closed down, but never without comment. We really do welcome the input and help, so please don't feel shy. If you feel we've closed your issue and that it had true merit, feel free to comment on it after closing, bring it up in the discussion group, or even email us at [email protected] — we want your participation.