GitHub Configuration for IETF Working Groups
draft-ietf-git-github-wg-configuration-03

Document Type Active Internet-Draft (git WG)
Last updated 2019-10-21
Stream IETF
Intended RFC status (None)
Formats plain text pdf htmlized 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)
GIT Working Group                                              A. Cooper
Internet-Draft                                                     Cisco
Intended status: Informational                                P. Hoffman
Expires: April 23, 2020                                            ICANN
                                                        October 21, 2019

              GitHub Configuration for IETF Working Groups
                draft-ietf-git-github-wg-configuration-03

Abstract

   The use of GitHub in IETF working group processes is increasing.
   This document describes possible uses and conventions for working
   groups which are considering starting to use GitHub.  It does not
   mandate any processes, and does not require changes to the processes
   used by current and future working groups not using GitHub.

   Discussion of this document takes place on the ietf-and-github
   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 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 April 23, 2020.

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

Cooper & Hoffman         Expires April 23, 2020                 [Page 1]
Internet-Draft           WG GitHub Configuration            October 2019

   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  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Administrative Process and Conventions  . . . . . . . . . . .   3
     2.1.  Creation of GitHub Organizations  . . . . . . . . . . . .   3
     2.2.  Migration of an Existing Organization . . . . . . . . . .   4
     2.3.  Personnel Changes . . . . . . . . . . . . . . . . . . . .   4
     2.4.  Working Group Closing . . . . . . . . . . . . . . . . . .   4
     2.5.  Creation of Document Repository . . . . . . . . . . . . .   4
   3.  Working Group Process . . . . . . . . . . . . . . . . . . . .   5
     3.1.  Contributions . . . . . . . . . . . . . . . . . . . . . .   5
     3.2.  Backing Up and Archiving GitHub Content . . . . . . . . .   6
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .   6
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   6
   6.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   6
     6.1.  Normative References  . . . . . . . . . . . . . . . . . .   6
     6.2.  Informative References  . . . . . . . . . . . . . . . . .   6
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .   7

1.  Introduction

   Many IETF working groups and participants make use of GitHub in
   different ways as part of their work on IETF documents.  Some others
   are interested in having their working groups use GitHub to
   facilitate the development of working group documents, but they are
   unfamiliar with how to get started or they are unclear about which
   conventions to follow.  Some other working groups use or plan to use
   other other code repository services such as GitLab and Bitbucket,
   which have different properties than GitHub.

   This document proposes a set of administrative processes and
   conventions for IETF working groups to use if they chose as a working
   group to use GitHub to facilitate their work.  The proposals in this
   document are not directed at working groups or individuals that are
   already using GitHub to do IETF work.  Practices vary among existing
   working groups and some of them are not consistent with the
   conventions proposed here: that is fine.  The goal of the proposals
   in this document is not to require uniformity in current practice,
   but to help working groups to get started using GitHub in a uniform
   way if they want to.
Show full document text