Skip to content

Latest commit

 

History

History
84 lines (61 loc) · 2.87 KB

rfc049-track-rfcs.md

File metadata and controls

84 lines (61 loc) · 2.87 KB
RFC Title Author Status Type
49
Tracking for Standards Track RFCs
John Keiser <[email protected]>
Accepted
Process

Tracking for Standards Track RFCs

Standards Track RFCs are intended for implementation. This proposal aims to make it easier to tell when an RFC is implemented or withdrawn, or what its implementation status is.

Motivation

As a Chef Contributor,
I want to know whether an RFC is actually being worked on,
so that I can decide whether to wait, write it myself, or write a replacement RFC.

As a Chef Contributor,
I want to know whether an RFC has become withdrawn,
So that I can decide whether to find a new owner for the subject.

Specification

Tracking Metadata Field

RFCs will now include a metadata field called Tracking, which will be a list of URLs to github issues on the relevant repositories where the feature is tracked.

For example, metadata might look like this:

---
RFC: XXX
Author: Daniel DeLeo <[email protected]>
Status: Final
Type: Standards Track
Chef-Version: 12.0
Tracking:
  - https://github.com/chef/chef/issues/12345
---

ALL accepted Standards Track RFCs will have:

  • Status of Accepted or Final
  • Tracking URLs containing at a minimum a Github issue (unless it is an old RFC with Final status, in which case Tracking URLs are optional)
  • Chef-Version (if Final)

RFC "Withdrawn" status

When the author of an RFC is no longer willing to work on it and no one has stepped up to do it--the RFC is updated to reflect that fact with the Withdrawn status as documented in RFC-00. If someone else wants to step back up, they will need to re-present the RFC and have it Accepted again.

RFC Acceptance Process Modification

When a Standards Track RFC is accepted, we will do all the normal things we do, plus file a github issue for implementation (or link to the existing issue or PR), and mark the Tracking field with that URL.

Finalization

When the implementation issue is resolved as fixed, we mark the RFC Final (or add other issues tracking the remaining work) and mark the Chef-Version in which it was shipped. Issue URLs remain on the RFCs for historical purposes.

Existing RFCs

All existing Accepted Standards Track RFCs will either be marked Final or have Tracking attached to them. The implementer of a specific RFC is responsible for submitting a PR to mark it as final. They may optionally be marked Withdrawn if they are no longer going to be worked on.

RFC editors are authorized to accept Pull Requests to change the status of an RFC from "Accepted" to "Final" without the need for explicit approval from the project lead.

Copyright

This work is in the public domain. In jurisdictions that do not allow for this, this work is available under CC0. To the extent possible under law, the person who associated CC0 with this work has waived all copyright and related or neighboring rights to this work.