Using GitHub at the IETF
draft-ietf-git-using-github-00

Document Type Active Internet-Draft (git WG)
Last updated 2019-04-12
Stream IETF
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Stream WG state WG Document
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
Network                                                       M. Thomson
Internet-Draft                                                   Mozilla
Intended status: Best Current Practice                    March 30, 2019
Expires: October 1, 2019

                        Using GitHub at the IETF
                     draft-ietf-git-using-github-00

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
   [1].

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 October 1, 2019.

Copyright Notice

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

   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

Thomson                  Expires October 1, 2019                [Page 1]
Internet-Draft              IETF GitHub Usage                 March 2019

   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  . . . . . . . . . . . . . . . . . . . . . . . . .   3
     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.  Backup and Archive Requirements . . . . . . . . . . . . .   6
     2.3.  Communicating Policies  . . . . . . . . . . . . . . . . .   6
       2.3.1.  Contribution Policies on Repositories . . . . . . . .   6
   3.  Deciding to Use GitHub  . . . . . . . . . . . . . . . . . . .   7
     3.1.  What to Use GitHub For  . . . . . . . . . . . . . . . . .   7
     3.2.  Working Group Policies  . . . . . . . . . . . . . . . . .   7
     3.3.  Repositories  . . . . . . . . . . . . . . . . . . . . . .   8
     3.4.  Editors and Contributors  . . . . . . . . . . . . . . . .   8
     3.5.  Document Formats  . . . . . . . . . . . . . . . . . . . .   9
   4.  Contribution Methods  . . . . . . . . . . . . . . . . . . . .   9
     4.1.  Issues  . . . . . . . . . . . . . . . . . . . . . . . . .   9
       4.1.1.  Issue Labelling . . . . . . . . . . . . . . . . . . .  10
       4.1.2.  Closing Issues  . . . . . . . . . . . . . . . . . . .  10
     4.2.  Pull Requests . . . . . . . . . . . . . . . . . . . . . .  10
       4.2.1.  Discussion on Pull Requests . . . . . . . . . . . . .  11
       4.2.2.  Merging Pull Requests . . . . . . . . . . . . . . . .  11
     4.3.  Monitoring Activity . . . . . . . . . . . . . . . . . . .  11
   5.  Internet-Draft Publication  . . . . . . . . . . . . . . . . .  12
   6.  Assessing Consensus . . . . . . . . . . . . . . . . . . . . .  12
   7.  Continuous Integration  . . . . . . . . . . . . . . . . . . .  13
   8.  Advice to Editors . . . . . . . . . . . . . . . . . . . . . .  13
   9.  GitHub Limitations  . . . . . . . . . . . . . . . . . . . . .  14
   10. Security Considerations . . . . . . . . . . . . . . . . . . .  14
   11. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  15
   12. References  . . . . . . . . . . . . . . . . . . . . . . . . .  15
     12.1.  Normative References . . . . . . . . . . . . . . . . . .  15
     12.2.  Informative References . . . . . . . . . . . . . . . . .  15
     12.3.  URIs . . . . . . . . . . . . . . . . . . . . . . . . . .  16
   Appendix A.  Experiences from Working Groups  . . . . . . . . . .  16
     A.1.  CORE  . . . . . . . . . . . . . . . . . . . . . . . . . .  16
Show full document text