Shortcut Release Cycle

One of the goals of Team Shortcut is for anyone looking at the repo to be able to understand what work is being done, what is not being done, and why. And thus: release cycle meta documentation.

Release Planning

Shortcut uses ZenHub to plan releases -- it includes all of the essential project management and planning features that GitHub lacks. It also deprecates nicely, so while you'll see the occasional tag on an issue specific to ZenHub (eg: "epic"), the rest of Shortcut should remain as easy to understand as any other GitHub repo.

Triage

All issues and pull requests get triaged by Shortcut's development team on a rolling basis and as part of building a new milestone. Triage includes adding tags to issues -- you don't have to tag issues when you create them.

Here are the tags Shortcut uses and what they mean:

• bug -- a behavior that isn't desirable or intended
• duplicate -- the issue has already been reported elsewhere
• enhancement -- adding functionality to Shortcut
• epic -- this is a ZenHub thing, it clusters issues together, please ignore it
• help wanted -- the issue requires assistance
• priority: high -- should get attention very soon
• priority: low -- can be worked on at any time
• priority: medium -- an issue of average urgency
• question -- the issue is asking a question
• task -- the issue is a task
• won't fix -- an issue that won't be fixed

Milestones

Shortcut uses GitHub's Milestone feature to make visible chunks of development time aka a "release". If you like using Agile terminology, these would be called "sprints". Generally the milestones are 2 weeks long. (ZenHub's "story points" feature, using points as hours of estimated work, is part of determining how much work is getting scheduled.) All milestones have due dates, because this isn't a hobby. And again, to see a list of all current and planned milestones for Shortcut, go here.