Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.6 KB

MAINTAINERS.adoc

File metadata and controls

45 lines (29 loc) · 2.6 KB
Raw

Maintainer’s Guide

Table of Contents

This guide is intended for contributors tagged as reviewers on a pull request or have triage, write, or maintainer roles on the Code Coffee Compendium repo.

Workflow

We use the github flow for managing this repository. At a glance, this means:

  • a main branch. This branch MUST be releasable at all times. New branches should be created from this branch. Pull requests made to this branch should be linked to one or more issues.

Issue triage process

Issues are tracked using the GitHub issue tracker. See Quickstart for GitHub Issues.

Issue triaging responsibilities include:

  • Labeling Issue. Labels are used to identify a category, in order to narrow the scope and subject matter of an open issue. See Adding labels.

  • Resolving duplicates. Newly reported duplicate issues can be resolved using the duplicate label.

  • Adding to a milestone. Issues can be included as part of an existing milestone. See Adding milestones.

  • Adding to a project. Issues can be included as part of an existing project. See Adding the issue to a project.

  • Communicating. Contributors are encouraged to engage conversation in the form of comments on an issue. See Communicating.

Reviewing a pull request

To review a pull request,

  1. Verify that the pull request is linked to one or more issues. See Linking a pull request to an issue.

  2. Verify that the contents of a pull request conforms to the Content style guide.

  3. Verify that the contents of a pull request adequately resolves its linked issues.

  4. Provide comments, approval, or request for changes. See About pull request reviews.

Merge process

A pull request can be merged once it has been approved by one or more reviewer.