othmane/ohif-viewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
09353354c3
ohif-viewer/docs/latest/our-process.md
Danny Brown 09353354c3
docs: start "our process" docs
2019-11-19 02:08:46 -05:00

2.1 KiB
Raw Blame History

Our Process

Our process is a living, breathing thing. We strive to have regular retrospectives 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

GitHub 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?