Working Group GitHub Usage Guidance
draft-ietf-git-using-github-03

Document Type Active Internet-Draft (git WG)
Last updated 2020-01-21 (latest revision 2019-12-31)
Stream IETF
Intended RFC status Best Current Practice
Formats plain text html xml pdf htmlized bibtex
Stream WG state Submitted to IESG for Publication
Document shepherd Christopher Wood
Shepherd write-up Show (last changed 2020-01-20)
IESG IESG state Publication Requested
Consensus Boilerplate Yes
Telechat date
Responsible AD Alissa Cooper
Send notices to Christopher Wood <caw@heapingbits.net>
Network                                                       M. Thomson
Internet-Draft                                                   Mozilla
Intended status: Best Current Practice                          B. Stark
Expires: 3 July 2020                                                AT&T
                                                        31 December 2019

                  Working Group GitHub Usage Guidance
                     draft-ietf-git-using-github-03

Abstract

   This document describes best practices for Working Groups that use
   GitHub for their work.

Note to Readers

   Discussion of this document takes place on the GitHub@ietf mailing
   list (ietf-and-github@ietf.org), which is archived at
   https://mailarchive.ietf.org/arch/search?email_list=ietf-and-github
   (https://mailarchive.ietf.org/arch/search?email_list=ietf-and-
   github).

   Source for this draft and an issue tracker can be found at
   https://github.com/ietf-gitwg/using-github (https://github.com/ietf-
   gitwg/using-github).

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on 3 July 2020.

Copyright Notice

   Copyright (c) 2019 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

Thomson & Stark            Expires 3 July 2020                  [Page 1]
Internet-Draft            GitHub Usage Guidance            December 2019

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents (https://trustee.ietf.org/
   license-info) in effect on the date of publication of this document.
   Please review these documents carefully, as they describe your rights
   and restrictions with respect to this document.  Code Components
   extracted from this document must include Simplified BSD License text
   as described in Section 4.e of the Trust Legal Provisions and are
   provided without warranty as described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Distributed Version Control Systems . . . . . . . . . . .   3
     1.2.  GitHub  . . . . . . . . . . . . . . . . . . . . . . . . .   4
     1.3.  Other Services  . . . . . . . . . . . . . . . . . . . . .   4
     1.4.  Document Goals  . . . . . . . . . . . . . . . . . . . . .   4
     1.5.  Notational Conventions  . . . . . . . . . . . . . . . . .   5
   2.  Administrative Policies . . . . . . . . . . . . . . . . . . .   5
     2.1.  Organizations . . . . . . . . . . . . . . . . . . . . . .   5
     2.2.  Communicating Policies  . . . . . . . . . . . . . . . . .   6
   3.  Deciding to Use GitHub  . . . . . . . . . . . . . . . . . . .   6
     3.1.  What to Use GitHub For  . . . . . . . . . . . . . . . . .   7
     3.2.  Repositories  . . . . . . . . . . . . . . . . . . . . . .   7
     3.3.  Editors and Contributors  . . . . . . . . . . . . . . . .   8
     3.4.  Document Formats  . . . . . . . . . . . . . . . . . . . .   9
   4.  Contribution Methods  . . . . . . . . . . . . . . . . . . . .   9
     4.1.  Issue Tracker . . . . . . . . . . . . . . . . . . . . . .   9
       4.1.1.  Issue Labels  . . . . . . . . . . . . . . . . . . . .  10
       4.1.2.  Closing Issues  . . . . . . . . . . . . . . . . . . .  10
       4.1.3.  Reopening Issues  . . . . . . . . . . . . . . . . . .  10
     4.2.  Pull Requests . . . . . . . . . . . . . . . . . . . . . .  10
       4.2.1.  Discussion on Pull Requests . . . . . . . . . . . . .  11
       4.2.2.  Merging Pull Requests . . . . . . . . . . . . . . . .  12
     4.3.  Monitoring Activity . . . . . . . . . . . . . . . . . . .  12
   5.  Typical Working Group Policies  . . . . . . . . . . . . . . .  12
     5.1.  Document Management Mode  . . . . . . . . . . . . . . . .  13
     5.2.  Issue Tracking Mode . . . . . . . . . . . . . . . . . . .  13
     5.3.  Issue Discussion Mode . . . . . . . . . . . . . . . . . .  14
       5.3.1.  Early Design Phases . . . . . . . . . . . . . . . . .  15
       5.3.2.  Managing Mature Documents . . . . . . . . . . . . . .  15
     5.4.  Issue Labelling Schemes . . . . . . . . . . . . . . . . .  16
       5.4.1.  Editorial/Design Labelling  . . . . . . . . . . . . .  16
       5.4.2.  Decision Labelling  . . . . . . . . . . . . . . . . .  17
       5.4.3.  Component Labelling . . . . . . . . . . . . . . . . .  17
Show full document text