Skip to content

Commit

Permalink
doc: Add platform_reviewer_checklist (RobotLocomotion#10431)
Browse files Browse the repository at this point in the history
  • Loading branch information
jwnimmer-tri authored Jan 18, 2019
1 parent 1305ea5 commit 3faea62
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 16 deletions.
1 change: 1 addition & 0 deletions doc/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ Issue Tracking
:maxdepth: 1

issues
platform_reviewer_checklist

Code Review
===========
Expand Down
23 changes: 7 additions & 16 deletions doc/issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,20 @@ of the following:
* ``status``: PRs only. Indicates the status of the PR.

Please only assign labels if you are reasonably confident they are correct.
The Drake development team will apply appropriate labels to issues during
the weekly scrub.
The Drake development team will apply appropriate labels later as needed.

Owner
=====

All GitHub issues should have an owner. The Platform Reviewer should check once
per day that `all unassigned issues
<https://github.com/RobotLocomotion/drake/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee>`_
have an appropriate owner.
Every issue must have at least one owner assigned.

.. _issues-team:

Team
====

Every issue must have at least one ``team`` label. If no team agrees to own an
issue, the issue will be closed with an explanation. The teams, their leads,
and their responsibilities are:
Every issue must have at least one ``team`` label. The teams, their leads, and
their responsibilities are:

- ``automotive``

Expand Down Expand Up @@ -66,15 +63,9 @@ and their responsibilities are:

responsibilities: MIT CSAIL research lab / MIT courses

Type
====
Every issue must have at least one ``type``, and typically should have exactly
one. Issues that require a code change will typically have type ``bug``,
``feature request``, or ``cleanup``. There are a number of niche types for
other kinds of issues, and the exact set is expected to evolve over time.

Priority
========

The ``emergency`` priority indicates that the owning team should not work
on anything else until the issue is resolved.

Expand Down
27 changes: 27 additions & 0 deletions doc/platform_reviewer_checklist.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _platform_reviewer_checklists:

****************************
Platform Reviewer Checklists
****************************

There are several policies documented in :ref:`GitHub Issue Management
<issues>` that the on-call platform reviewer should enforce. The on-call
reviewer should run through this checklist at least once per day.

Search for `issues without an assigned team
<https://github.com/RobotLocomotion/drake/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+-label%3A%22team%3A+automotive%22+-label%3A%22team%3A+dynamics%22+-label%3A%22team%3A+kitware%22+-label%3A%22team%3A+manipulation%22+-label%3A%22team%3A+russ%22+-label%3A%22team%3A+robot+locomotion+group%22>`_
and assign a team. When in doubt, seek advice on slack.

Search for `issues without an assigned individual
<https://github.com/RobotLocomotion/drake/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee>`_
and assign an owner. When in doubt, assign :ref:`the lead <issues-team>`
associated with the issue's ``team`` label.

Search for `pull requests that need review
<https://github.com/RobotLocomotion/drake/pulls?q=is%3Aopen+is%3Apr+no%3Aassignee+-label%3A%22status%3A+do+not+review%22>`_
and (probably) assign a feature reviewer. This is intended to make sure that
requests from outside developers receive timely attention. For a pull request
by a core Drake Developer, leaving it unassigned may be acceptable when it is
clearly an early work-in-progress -- but if it is unassigned for several days,
you should probably encourage the developer to label it "do not review" for
clarity.

0 comments on commit 3faea62

Please sign in to comment.