Find Code Related to an Internet-Draft or RFC
draft-eckel-edm-find-code-04

edm                                                             C. Eckel
Internet-Draft                                             Cisco Systems
Intended status: Best Current Practice                   22 January 2024
Expires: 25 July 2024

             Find Code Related to an Internet-Draft or RFC
                      draft-eckel-edm-find-code-04

Abstract

   Code related to existing IETF standards and ongoing standardization
   efforts may exist and be publicly accessible in many places.  This
   document provides a set of practices to make it easier to identify
   and find such code.

Discussion Venues

   This note is to be removed before publishing as an RFC.

   Discussion of this document takes place on the Evolvability,
   Deployability, & Maintainability IAB Program mailing list
   (edm@iab.org), which is archived at
   https://mailarchive.ietf.org/arch/browse/edm/.

   Source for this draft and an issue tracker can be found at
   https://github.com/eckelcu/draft-eckel-edm-find-code.

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 25 July 2024.

Eckel                     Expires 25 July 2024                  [Page 1]
Internet-Draft                  find-code                   January 2024

Copyright Notice

   Copyright (c) 2024 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 to this document.  Code Components
   extracted from this document must include Revised BSD License text as
   described in Section 4.e of the Trust Legal Provisions and are
   provided without warranty as described in the Revised BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Existing IETF Processes and Procedures  . . . . . . . . . . .   3
     2.1.  Implementation Status . . . . . . . . . . . . . . . . . .   3
     2.2.  GitHub  . . . . . . . . . . . . . . . . . . . . . . . . .   3
     2.3.  Hackathon . . . . . . . . . . . . . . . . . . . . . . . .   4
   3.  Proposal  . . . . . . . . . . . . . . . . . . . . . . . . . .   4
     3.1.  GitHub Repository . . . . . . . . . . . . . . . . . . . .   4
     3.2.  README  . . . . . . . . . . . . . . . . . . . . . . . . .   5
     3.3.  Datatracker . . . . . . . . . . . . . . . . . . . . . . .   5
       3.3.1.  Permissions . . . . . . . . . . . . . . . . . . . . .   6
       3.3.2.  Guidance  . . . . . . . . . . . . . . . . . . . . . .   6
     3.4.  Implementation Status . . . . . . . . . . . . . . . . . .   6
     3.5.  Inline Errata . . . . . . . . . . . . . . . . . . . . . .   7
     3.6.  Known Limitations . . . . . . . . . . . . . . . . . . . .   7
   4.  Implementation Status . . . . . . . . . . . . . . . . . . . .   7
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .   8
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   8
   7.  Informative References  . . . . . . . . . . . . . . . . . . .   8
   Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . .   8
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .   9

1.  Introduction

   Code related to existing IETF standards and ongoing standardization
   efforts may exist and be publicly accessible in many places.  One
   common place is GitHub (https://github.com/), but there are many
   others.  The relationship of the code to corresponding IETF standards
   efforts may be direct, as in the case of a client or server that
   supports protocol defined by an Internet-Draft (I-D)
   (https://www.ietf.org/standards/ids/).  It may be indirect, as in a
   utility that helps analyze network traffic corresponding to this same
   protocol.  The maturity and status of the code may vary considerably,

Eckel                     Expires 25 July 2024                  [Page 2]
Internet-Draft                  find-code                   January 2024

   including something written quickly as a proof of concept during a
   hackathon, a well established and supported implementation, or a
   legacy project no longer actively developed or maintained.  The code