This process attempts to emulate the success of the Rust programming language and as such has almost mirrored the RFC process the Rust developers use, which is tried and tested and appears to work very well.
Many changes, including bug fixes and documentation improvements can be implemented and reviewed via the normal GitHub pull request workflow.
Some changes though are "substantial", and we ask that these be put through a bit of a design process and produce a consensus among the community and the core team.
The "RFC" (request for comments) process is intended to provide a consistent and controlled path for new features to enter the network and core libraries, so that all stakeholders can be confident about the direction in which the network is evolving.
Table of Contents
- Active RFCs
- When you need to follow this process
- Before creating an RFC
- What the process is
- The role of the shepherd
- The RFC life-cycle
- Reviewing RFCs
- Implementing an RFC
- Help! This is all too informal
List of active RFCs
All currently-active RFCs can be found on the status page.
When you need to follow this process
You need to follow this process if you intend to make "substantial" changes to VinylDNS libraries, dependencies, algorithms or the RFC process itself. What constitutes a "substantial" change is evolving based on community norms, but may include the following:
- Any semantic or syntactic change to the existing algorithms and process that is not a bug fix.
- Any proposed additions to existing algorithms
- Any proposed additional functionality
- Anything that reduces interoperability (e.g. changes to the wire protocol or data serialisation.)
Some changes do not require an RFC:
- Rephrasing, re-organising, refactoring, or otherwise "changing shape does not change meaning"
- Additions that strictly improve objective, numerical quality criteria (warning removal, speedup, better platform coverage, more parallelism, trap more errors…etc…)
- Additions only likely to be noticed by other developers-of-VinylDNS, invisible to app-developers-of-VinylDNS (i.e. API users)
If you submit a pull request to implement a new feature without going through the RFC process, it may be closed with a polite request to submit an RFC first.
Before creating an RFC
A hastily proposed RFC can hurt its chances of acceptance. Low quality proposals, proposals for previously rejected features, may be quickly rejected, which can be demotivating for the unprepared contributor. Laying some groundwork ahead of the RFC can make the process smoother.
Although there is no single way to prepare for submitting an RFC, it is generally a good idea to pursue feedback from other project developers beforehand to ascertain that the RFC may be desirable. Having a consistent impact on the project requires concerted effort toward consensus-building.
As a rule of thumb, receiving encouraging feedback from long-standing project developers, and particularly members of the core team or existing contributors, is a good indication that the RFC is worth pursuing.
- Open an issue https://github.com/vinyldns/vinyldns/issues to discuss a new feature or enhancement
- After discussion on the issue, the issue maybe small enough where an RFC is not warranted. In this case, the issue will be moved to
readyor in progress for development.
- If the issue does warrant an RFC (at the discretion of the maintainers commenting on the issue tracker), follow the process defined below on setting up a new RFC.
High level RFC Process
- Start a new RFC as a Pull Request. The RFC enters a "Proposed" status.
- A shepherd / maintainer will review your RFC and help get it to the point of consideration. Typically this will be to comment on your PR.
- As the RFC Author, make changes to your PR to evolve it to the point where all questions are answered and comments are addressed.
- How long an RFC remains in the "Proposed" status is up to the author and shepherd. This could be a day, or several weeks.
- When the RFC has been reviewed and updated, it will be "proposed for final comment period". It will also be assigned a dispostion.
disposition-mergemeans to move it forward to implementation.
disposition-postponeindicates we will close and revisit at a later time.
disposition-closeindicates that the RFC will not move forward for reasons indicated on the PR and RFC.
- The final comment period stays open for 5 business days, after which, unless there are significant objections, the RFC moves to the proposed disposition.
- When an RFC is accepted, the author is free to begin development. PRs should be linked to the issue tracker for the RFC. If the author is not an implementer, it will go into the backlog of development for the maintainers, to be implemented as time allows.
What the process is
In short, to get a major feature added, one must first get the RFC merged into the RFC repo as a markdown file. At that point, the RFC is "proposed" and may be implemented with the goal of eventual inclusion into VinylDNS, at which point it becomes "active".
- Fork the RFC repo https://github.com/vinyldns/rfcs
- Note: if you want to use an all Github approach, you can:
- Go to your forked repository
- In the main page, click the
- Enter your RFC name in kebab-case there (for example
my-new-rfc) and hit
Enterto create the new branch
- Click on the
Create new Filebutton
- Follow the directions here. When finished, at the bottom of the screen enter the commit details. Be sure to click "Merge directly into this branch." Double-check you are on your
my-new-rfcbranch and not master.
- Open the pull request.
- Decide on a clear and brief title for the new rfc, make it descriptive and unique. Copy
text/0000-my-new-rfc.md, where 'my-new-rfc' is the kebab-cased version of the RFC title, any non-letters removed. Don't assign an RFC number yet!
- Fill in the RFC.
- The first line should be the titled-cased version of the RFC, prefixed with the
#(hash and space) followed by a blank line. This should be the only first-degree headline in the entire RFC!
- Put care into the details: RFCs that do not present convincing motivation, demonstrate understanding of the impact of the design, or are disingenuous about the drawbacks or alternatives tend to be poorly-received.
- If it makes sense, feel free to add further files in the same folder, giving further information, images or appendix, as long as they start with a non-number letter. For example, you may split the details of separate files per component touched.
- The first line should be the titled-cased version of the RFC, prefixed with the
- Submit a pull request. As a pull request the RFC will receive design feedback from the larger community and the author should be prepared to revise it in response.
- During triage, the pull request will either be closed (for RFCs that clearly will not be accepted), or assigned to a shepherd. The shepherd is a trusted developer who is familiar with the process, who will help to move the RFC forward and ensure that the right people see and review it.
- Build consensus and integrate feedback. RFCs that have broad support are much more likely to make progress than those that don't receive any comments. The shepherd assigned to your RFC should help you get feedback from developers as well.
- The shepherd may schedule meetings with the author and/or relevant stakeholders to discuss the issues in greater detail and in some cases the topic may be discussed at the larger [weekly meeting]. In either case a summary from the meeting will be posted back to the RFC pull request.
- Once both proponents and opponents have clarified and defended positions and the conversation has settled, the shepherd will take it to the contributor team for a final decision.
- Eventually, someone from the contributor team will either accept the RFC by merging the pull request, assigning the RFC a number (corresponding to the pull request number), at which point the RFC is "active", or reject it by closing the pull request.
The role of the shepherd
During triage, every RFC will either be closed or assigned a shepherd. The role of the shepherd is to move the RFC through the process. This starts with simply reading the RFC in detail and providing initial feedback. The shepherd should also solicit feedback from people who are likely to have strong opinions about the RFC. Finally, when this feedback has been incorporated and the RFC seems to be in a steady state, the shepherd will bring it to the meeting. In general, the idea here is to "front-load" as much of the feedback as possible before the point where we actually reach a decision.
The RFC life-cycle
Once an RFC becomes active then authors may implement it and submit the feature as a pull request to the repo. Being "active" is not a rubber stamp and in particular still does not mean the feature will ultimately be merged. It does mean that in principle all the major stakeholders have agreed to the feature and are amenable to merging it.
Furthermore, the fact that a given RFC has been accepted and is "active" implies nothing about what priority is assigned to its implementation, nor does it imply anything about whether a developer has been assigned the task of implementing the feature. While it is not necessary that the author of the RFC also write the implementation, it is by far the most effective way to see an RFC through to completion. Authors should not expect that other project developers will take on responsibility for implementing their accepted feature.
Modifications to active RFCs can be done in follow up PRs. We strive to write each RFC in a manner that it will reflect the final design of the feature, however, the nature of the process means that we cannot expect every merged RFC to actually reflect what the end result will be at the time of the next major release. We therefore try to keep each RFC document somewhat in sync with the network feature as planned, tracking such changes via followup pull requests to the document.
An RFC that makes it through the entire process to implementation is considered "implemented" and is moved to the "implemented" folder. An RFC that fails after becoming active is "rejected" and moves to the "rejected" folder.
While the RFC PR is up, the shepherd may schedule meetings with the author and/or relevant stakeholders to discuss the issues in greater detail. In some cases the topic may be discussed at the larger [weekly meeting]. In either situation, a summary from the meeting will be posted back to the RFC pull request.
The core team make final decisions about RFCs after the benefits and drawbacks are well understood. These decisions can be made at any time, but the core team will regularly issue decisions on at least a weekly basis. When a decision is made, the RFC PR will either be merged or closed, in either case with a comment describing the rationale for the decision. The comment should largely be a summary of discussion already on the comment thread.
Implementing an RFC
Some accepted RFCs represent vital features that need to be implemented right away. Other accepted RFCs can represent features that can wait until some arbitrary developer feels like doing the work. Every accepted RFC has an associated issue tracking its implementation in the affected repositories. Therefore, the associated issue can be assigned a priority via the triage process that the team uses for all issues in the appropriate repositories.
The author of an RFC is not obligated to implement it. Of course, the RFC author (like any other developer) is welcome to post an implementation for review after the RFC has been accepted.
If you are interested in working on the implementation for an "active" RFC, but cannot determine if someone else is already working on it, feel free to ask (e.g. by leaving a comment on the associated issue). Any issues assigned to a sprint will be clearly marked as such in the library issue tracker.
Help! This is all too informal
The process is intended to be as lightweight as reasonable for the present circumstances. As usual, we are trying to let the process be driven by consensus and community norms, not impose more structure than necessary.