From 09353354c3194c30c0c0a4f2dc4cfea0653fd51e Mon Sep 17 00:00:00 2001 From: Danny Brown Date: Tue, 19 Nov 2019 02:08:46 -0500 Subject: [PATCH] docs: start "our process" docs --- docs/latest/our-process.md | 46 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/latest/our-process.md diff --git a/docs/latest/our-process.md b/docs/latest/our-process.md new file mode 100644 index 000000000..aea3fc7fc --- /dev/null +++ b/docs/latest/our-process.md @@ -0,0 +1,46 @@ +# Our Process + +Our process is a living, breathing thing. We strive to have regular [retrospectives][retrospective] that help us +shape and adapt our process to our team's current needs. This document attempts to capture the broad strokes of +that process, and how it + + + + +- Issue Triage +- Issue Curation (["backlog grooming"][groom-backlog]) + +## Issue Triage + +[GitHub issues][gh-issues] are the best way to provide feedback, ask questions, and suggest changes to the OHIF Viewer's core +team. Community issues generally fall into one of three categories, and are marked with a `triage` label when created. + + +|Issue Template Name | Description | +|------------------------|-----------------------------------------------------------------------------------------| +|Community: Report 🐛 | Describe a new issue; Provide steps to reproduce; Expected versus actual result? | +|Community: Request ✋ | Describe a proposed new feature. Why should it be implemented? What is the impact/value? | +|Community: Question ❓ | Seek clarification or assistance relevant to the repository. | + +_fig. Table containing issue template names and descriptions_ + +Issues that require `triage` are akin to support tickets. As this is often our first contact with would-be adopters and +contributors, it's important that we strive for timely responses and satisfactory resolutions. We attempt to accomplish this +by: + +1. Responding to issues requiring `triage` at least once a week +2. Providing clear "in-progress" and "complete" states for issues + + +> Less obviously, patterns in the issues being reported can highlight areas that need improvement. For example, users often have +difficulty navigating CORS issues when deploying the OHIF Viewer -- how do we best reduce our ticket volume for this issue? + + + + +[groom-backlog]: https://www.agilealliance.org/glossary/backlog-grooming +[retrospective]: https://www.atlassian.com/team-playbook/plays/retrospective +[gh-issues]: https://github.com/OHIF/Viewers/issues/new/choose +