Repository files navigation

The "RFC" (request for comments) process is intended to provide aconsistent and controlled path for new features to enter the framework.

Many changes, including bug fixes and documentation improvements can beimplemented and reviewed via the normal GitHub pull request workflow.

Some changes though are "substantial", and we ask that these be putthrough a bit of a design process and produce a consensus among the Vuecore team and the community.

An RFC goes through the following stages:

• Pending: when the RFC is submitted as a PR.
• Active: when an RFC PR is merged and undergoing implementation.
• Landed: when an RFC's proposed changes are shipped in an actual release.
• Rejected: when an RFC PR is closed without being merged.

Pending RFC List

You need to follow this process if you intend to make "substantial"changes to one of the projects listed below:

• Vue core
• Vue Router
• Vuex
• Vue CLI

We are limiting the RFC process for these repos to test out the process in a more manageable fashion, and may expand it to cover more projects under thevuejs organization in the future. For now, if you wish to suggest changes to those other projects, please use their respective issue lists.

What constitutes a "substantial" change is evolving based on community norms, but may include the following:

• A new feature that creates new API surface area
• Changing the semantics or behavior of an existing API
• The removal of features that already shipped as part of the release channel.
• The introduction of new idiomatic usage or conventions, even if they do not include code changes to Vue itself.

Some changes do not require an RFC:

• Additions that strictly improve objective, numerical quality criteria (speedup, better browser support)
• Fixing objectively incorrect behavior
• Rephrasing, reorganizing or refactoring
• Addition or removal of warnings
• Additions only likely to benoticed by other implementors-of-Vue, invisible to users-of-Vue.

If you submit a pull request to implement a new feature without goingthrough the RFC process, it may be closed with a polite request tosubmit an RFC first.

It is great that you are considering suggesting new features or changes to Vue - we appreciate your willingness to contribute! However, as Vue becomes more widely used, we need to take stability more seriously, and thus have to carefully consider the impact of every change we make that may affect end users. On the other hand, we also feel that Vue has reached a stage where we want to start consciously preventing further complexity from new API surfaces.

These constraints and tradeoffs may not be immediately obvious to users who are proposing a change just to solve a specific problem they just ran into. The RFC process serves as a way to guide you through our thought process when making changes to Vue, so that we can be on the same page when discussing why or why not these changes should be made.

It's often helpful to get feedback on your concept before diving into thelevel of API design detail required for an RFC.You may open anissue on this repo to start a high-level discussion, with the goal ofeventually formulating an RFC pull request with the specific implementationdesign.

In short, to get a major feature added to Vue, one must first get theRFC merged into the RFC repo as a markdown file. At that point the RFCis 'active' and may be implemented with the goal of eventual inclusioninto Vue.

• Fork the RFC repohttp://github.com/vuejs/rfcs

• Copy0000-template.md toactive-rfcs/0000-my-feature.md (where'my-feature' is descriptive. don't assign an RFC number yet).

• Fill in the RFC. Put care into the details:RFCs that do notpresent convincing motivation, demonstrate understanding of theimpact of the design, or are disingenuous about the drawbacks oralternatives tend to be poorly-received.

• Submit a pull request. As a pull request the RFC will receive designfeedback from the larger community, and the author should be preparedto revise it in response.

• Build consensus and integrate feedback. RFCs that have broad supportare much more likely to make progress than those that don't receive anycomments.

• Eventually, thecore team will decide whether the RFC is a candidatefor inclusion in Vue.

• An RFC can be modified based upon feedback from thecore team and community. Significant modifications may trigger a new final comment period.

• An RFC may be rejected after public discussion has settledand comments have been made summarizing the rationale for rejection. A member of thecore team should then close the RFC's associated pull request.

• An RFC may be accepted at the close of its final comment period. Acore team member will merge the RFC's associated pull request, at which point the RFC will become 'active'.

Once an RFC becomes active then authors may implement it and submit thefeature as a pull request to the Vue repo. Becoming 'active' is not a rubberstamp, and in particular still does not mean the feature will ultimatelybe merged; it does mean that the core team has agreed to it in principleand 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 itsimplementation, nor whether anybody is currently working on it.

Modifications to active RFC's can be done in followup PR's. We striveto write each RFC in a manner that it will reflect the final design ofthe feature; but the nature of the process means that we cannot expectevery merged RFC to actually reflect what the end result will be atthe time of the next major release; therefore we try to keep each RFCdocument somewhat in sync with the language feature as planned,tracking such changes via followup pull requests to the document.

The author of an RFC is not obligated to implement it. Of course, theRFC author (like any other developer) is welcome to post animplementation for review after the RFC has been accepted.

An active RFC should have the link to the implementation PR listed if there is one. Feedback to the actual implementation should be conducted in the implementation PR instead of the original RFC PR.

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).

Members of thecore team will attempt to review some set of open RFCpull requests on a regular basis. If a core team member believes an RFC PR is ready to be accepted into active status, they can approve the PR using GitHub's review feature to signal their approval of the RFC.

Vue's RFC process owes its inspiration to theReact RFC process,Rust RFC process andEmber RFC process