From 708ffc26e908d1933a294c91c2cdf77d03a84be5 Mon Sep 17 00:00:00 2001 From: Shane Creighton-Young Date: Fri, 20 Mar 2015 21:55:26 -0700 Subject: [PATCH] Update readme with new intro --- README.md | 41 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d5f78fb3..6eea8858 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,40 @@ -# QKSMS public issue tracker +# QKSMS Issue Tracker -This repository is used as a public issue tracker for QKSMS. +This is a public issue tracker for QKSMS. [View the open issues](https://github.com/qklabs/qksms-tracker/issues). -View all open issues [here](https://github.com/qklabs/qksms-tracker/issues) +### Organization + +We accept two kinds of feedback: bug reports and enhancements. Bug reports identify problems in current functionality, and enhancements are new functionality. + +#### Bug reports +A great bug report contains a description of the problem and steps to reproduce the problem. We need to know what we're looking for and where to look for it. If the QKSMS team can't reproduce a bug, we will work with testers to fix the problem. + +Bugs are given the red `bug` label. Bugs also may be given extra orange labels: + +`needs-info`: We need a better description of the problem. +`needs-repro`: We need someone who can reproduce the issue consistently. +`needs-review`: We need someone to verify that the bug has been squashed. + +##### Example bug report submission +> *This is a real bug as of the time of writing. Try reproducing it!* + +``` +### DESCRIPTION +Conversations aren't marked as read when they are opened from a notification. + +### STEPS +1. Long press on a conversation and press "Mark as unread" to reveal a notification. +2. Press the home button to put QKSMS in the background. +3. Pull down on the notification to open the notification drawer. +4. Tap on the body of the notification (not the buttons). +5. Tap on the back button to reveal the conversation list. + +### EXPECTED +The conversation is marked as read. + +### REALITY +The conversation isn't marked as read. +``` + +#### Enhancements +There are no rules for enhancement requests. Your ideas are all awesome. Although we may not implement every suggestion, we love brainstorming with you and hearing your feedback.