docs: start "our process" docs
This commit is contained in:
parent
0a12320083
commit
09353354c3
46
docs/latest/our-process.md
Normal file
46
docs/latest/our-process.md
Normal file
@ -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?
|
||||||
|
|
||||||
|
<!--
|
||||||
|
LINKS
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!-- prettier-ignore-start -->
|
||||||
|
[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
|
||||||
|
<!-- prettier-ignore-end -->
|
||||||
Loading…
Reference in New Issue
Block a user