Using GitHub at the IETF
draft-thomson-github-bcp-00

Document Type Active Internet-Draft (individual)
Last updated 2017-02-17
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
On Agenda wugh at IETF-98
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network                                                  M. Thomson, Ed.
Internet-Draft                                                   Mozilla
Intended status: Best Current Practice                     A. Atlas, Ed.
Expires: August 22, 2017                                Juniper Networks
                                                       February 18, 2017

                        Using GitHub at the IETF
                      draft-thomson-github-bcp-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
   .

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 http://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 August 22, 2017.

Copyright Notice

   Copyright (c) 2017 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
   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents

Thomson & Atlas          Expires August 22, 2017                [Page 1]
Internet-Draft              IETF GitHub Usage              February 2017

   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.  Integrated Tools: GitLab and Git  . . . . . . . . . . . .   3
     1.2.  GitHub: Community Outreach  . . . . . . . . . . . . . . .   4
     1.3.  Notational Conventions  . . . . . . . . . . . . . . . . .   4
   2.  IETF Administrative Policies  . . . . . . . . . . . . . . . .   4
     2.1.  Naming and Ownership of Organizations . . . . . . . . . .   4
     2.2.  Backup and Archiving of Working Group's Organization and
           Repositories  . . . . . . . . . . . . . . . . . . . . . .   5
     2.3.  Communicating IETF Policies in GitHub or GitLab . . . . .   5
     2.4.  Communicating GitHub or GitLab Use inside IETF  . . . . .   6
   3.  Deciding to Use GitHub  . . . . . . . . . . . . . . . . . . .   6
     3.1.  What to Use GitHub For  . . . . . . . . . . . . . . . . .   6
     3.2.  Working Group Policies  . . . . . . . . . . . . . . . . .   7
     3.3.  Repositories  . . . . . . . . . . . . . . . . . . . . . .   7
     3.4.  Editors and Contributors  . . . . . . . . . . . . . . . .   8
     3.5.  Document Formats  . . . . . . . . . . . . . . . . . . . .   8
   4.  Contribution Methods  . . . . . . . . . . . . . . . . . . . .   8
     4.1.  Issues  . . . . . . . . . . . . . . . . . . . . . . . . .   9
       4.1.1.  Issue Labelling . . . . . . . . . . . . . . . . . . .   9
       4.1.2.  Closing Issues  . . . . . . . . . . . . . . . . . . .   9
     4.2.  Pull Requests . . . . . . . . . . . . . . . . . . . . . .   9
       4.2.1.  Discussion on Pull Requests . . . . . . . . . . . . .  10
       4.2.2.  Merging Pull Requests . . . . . . . . . . . . . . . .  10
     4.3.  Monitoring Activity . . . . . . . . . . . . . . . . . . .  11
   5.  Advice to Editors . . . . . . . . . . . . . . . . . . . . . .  11
   6.  Internet-Drafts . . . . . . . . . . . . . . . . . . . . . . .  12
   7.  Assessing Consensus . . . . . . . . . . . . . . . . . . . . .  12
   8.  Continuous Integration  . . . . . . . . . . . . . . . . . . .  12
   9.  GitHub Limitations  . . . . . . . . . . . . . . . . . . . . .  13
   10. Security Considerations . . . . . . . . . . . . . . . . . . .  13
   11. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  14
   12. References  . . . . . . . . . . . . . . . . . . . . . . . . .  14
     12.1.  Normative References . . . . . . . . . . . . . . . . . .  14
     12.2.  Informative References . . . . . . . . . . . . . . . . .  14
Show full document text