Skip to content

Commit 3774170

Browse files
committed
chore: readme + template
1 parent e03725d commit 3774170

2 files changed

Lines changed: 207 additions & 2 deletions

File tree

0000-template.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
- Start Date: (fill me in with today's date, YYYY-MM-DD)
2+
- Target Major Version: (7.x / 8.x)
3+
- Reference Issues: (fill in existing related issues, if any)
4+
- Implementation PR: (leave this empty)
5+
6+
# Summary
7+
8+
Brief explanation of the feature.
9+
10+
# Basic example
11+
12+
If the proposal involves a new or changed API, include a basic code example.
13+
Omit this section if it's not applicable.
14+
15+
# Motivation
16+
17+
Why are we doing this? What use cases does it support? What is the expected
18+
outcome?
19+
20+
Please focus on explaining the motivation so that if this RFC is not accepted,
21+
the motivation could be used to develop alternative solutions. In other words,
22+
enumerate the constraints you are trying to solve without coupling them too
23+
closely to the solution you have in mind.
24+
25+
# Detailed design
26+
27+
This is the bulk of the RFC. Explain the design in enough detail for somebody
28+
familiar with Vue to understand, and for somebody familiar with the
29+
implementation to implement. This should get into specifics and corner-cases,
30+
and include examples of how the feature is used. Any new terminology should be
31+
defined here.
32+
33+
# Drawbacks
34+
35+
Why should we *not* do this? Please consider:
36+
37+
- implementation cost, both in term of code size and complexity
38+
- whether the proposed feature can be implemented in user space
39+
- the impact on teaching people Vue
40+
- integration of this feature with other existing and planned features
41+
- cost of migrating existing Vue applications (is it a breaking change?)
42+
43+
There are tradeoffs to choosing any path. Attempt to identify them here.
44+
45+
# Alternatives
46+
47+
What other designs have been considered? What is the impact of not doing this?
48+
49+
# Adoption strategy
50+
51+
If we implement this proposal, how will existing Vue developers adopt it? Is
52+
this a breaking change? Can we write a codemod? Can we provide a runtime adapter library for the original API it replaces? How will this affect other projects in the Vue ecosystem?
53+
54+
# Unresolved questions
55+
56+
Optional, but suggested for first drafts. What parts of the design are still
57+
TBD?

README.md

Lines changed: 150 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,150 @@
1-
# rfcs
2-
RFCs for NativeScript and related tooling
1+
# Nativescript RFCs
2+
3+
## What is an RFC?
4+
5+
The "RFC" (request for comments) process is intended to provide a
6+
consistent and controlled path for new features to enter the framework.
7+
8+
Many changes, including bug fixes and documentation improvements can be
9+
implemented and reviewed via the normal GitHub pull request workflow.
10+
11+
Some changes though are "substantial", and we ask that these be put
12+
through a bit of a design process and produce a consensus among the Nativescript
13+
core team and the community.
14+
15+
## The RFC life-cycle
16+
17+
An RFC goes through the following stages:
18+
19+
- **Pending:** when the RFC is submitted as a PR.
20+
- **Active:** when an RFC PR is merged and undergoing implementation.
21+
- **Landed:** when an RFC's proposed changes are shipped in an actual release.
22+
- **Rejected:** when an RFC PR is closed without being merged.
23+
24+
[Pending RFC List](https://github.com/NativeScript/rfcs/pulls)
25+
26+
## When to follow this process
27+
28+
You need to follow this process if you intend to make "substantial"
29+
changes to one of the projects listed below:
30+
31+
- [NativeScript core/webpack](https://github.com/NativeScript/core)
32+
- [Nativescript Android Runtime](https://github.com/NativeScript/android-runtime)
33+
- [Nativescript iOS Runtime](https://github.com/NativeScript/ios-runtime)
34+
- [Nativescript iOS V8 Runtime](https://github.com/NativeScript/ns-v8ios-runtime)
35+
- [NativeScript CLI](https://github.com/NativeScript/nativescript-cli)
36+
37+
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 the `vuejs` organization in the future. For now, if you wish to suggest changes to those other projects, please use their respective issue lists.
38+
39+
What constitutes a "substantial" change is evolving based on community norms, but may include the following:
40+
41+
- A new feature that creates new API surface area
42+
- Changing the semantics or behavior of an existing API
43+
- The removal of features that are already shipped as part of the release channel.
44+
- The introduction of new idiomatic usage or conventions, even if they do not include code changes to Nativescript itself.
45+
46+
Some changes do not require an RFC:
47+
48+
- Additions that strictly improve objective, numerical quality criteria (speedup, better browser support)
49+
- Fixing objectively incorrect behavior
50+
- Rephrasing, reorganizing or refactoring
51+
- Addition or removal of warnings
52+
- Additions only likely to be _noticed by_ other implementors-of-Nativescript, invisible to users-of-Nativescript.
53+
54+
If you submit a pull request to implement a new feature without going
55+
through the RFC process, it may be closed with a polite request to
56+
submit an RFC first.
57+
58+
## Why do you need to do this
59+
60+
It is great that you are considering suggesting new features or changes to Nativescript - we appreciate your willingness to contribute! However, as Nativescript 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 Nativescript has reached a stage where we want to start consciously preventing further complexity from new API surfaces.
61+
62+
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 Nativescript, so that we can be on the same page when discussing why or why not these changes should be made.
63+
64+
## Gathering feedback before submitting
65+
66+
It's often helpful to get feedback on your concept before diving into the
67+
level of API design detail required for an RFC. **You may open an
68+
issue on this repo to start a high-level discussion**, with the goal of
69+
eventually formulating an RFC pull request with the specific implementation
70+
design.
71+
72+
## What the process is
73+
74+
In short, to get a major feature added to Nativescript, one must first get the
75+
RFC merged into the RFC repo as a markdown file. At that point the RFC
76+
is 'active' and may be implemented with the goal of eventual inclusion
77+
into Nativescript.
78+
79+
* Fork the RFC repo http://github.com/Nativescript/rfcs
80+
81+
* Copy `0000-template.md` to `active-rfcs/0000-my-feature.md` (where
82+
'my-feature' is descriptive. don't assign an RFC number yet).
83+
84+
* Fill in the RFC. Put care into the details: **RFCs that do not
85+
present convincing motivation, demonstrate understanding of the
86+
impact of the design, or are disingenuous about the drawbacks or
87+
alternatives tend to be poorly-received**.
88+
89+
* Submit a pull request. As a pull request the RFC will receive design
90+
feedback from the larger community, and the author should be prepared
91+
to revise it in response.
92+
93+
* Build consensus and integrate feedback. RFCs that have broad support
94+
are much more likely to make progress than those that don't receive any
95+
comments.
96+
97+
* Eventually, the [core team] will decide whether the RFC is a candidate
98+
for inclusion in Nativescript.
99+
100+
* An RFC can be modified based upon feedback from the [core team] and community. Significant modifications may trigger a new final comment period.
101+
102+
* An RFC may be rejected after public discussion has settled
103+
and comments have been made summarizing the rationale for rejection. A member of the [core team] should then close the RFC's associated pull request.
104+
105+
* An RFC may be accepted at the close of its final comment period. A [core team] member will merge the RFC's associated pull request, at which point the RFC will become 'active'.
106+
107+
## Details on Active RFCs
108+
109+
Once an RFC becomes active then authors may implement it and submit the
110+
feature as a pull request to the Nativescript repo. Becoming 'active' is not a rubber
111+
stamp, and in particular still does not mean the feature will ultimately
112+
be merged; it does mean that the core team has agreed to it in principle
113+
and are amenable to merging it.
114+
115+
Furthermore, the fact that a given RFC has been accepted and is
116+
'active' implies nothing about what priority is assigned to its
117+
implementation, nor whether anybody is currently working on it.
118+
119+
Modifications to active RFC's can be done in followup PR's. We strive
120+
to write each RFC in a manner that it will reflect the final design of
121+
the feature; but the nature of the process means that we cannot expect
122+
every merged RFC to actually reflect what the end result will be at
123+
the time of the next major release; therefore we try to keep each RFC
124+
document somewhat in sync with the language feature as planned,
125+
tracking such changes via followup pull requests to the document.
126+
127+
## Implementing an RFC
128+
129+
The author of an RFC is not obligated to implement it. Of course, the
130+
RFC author (like any other developer) is welcome to post an
131+
implementation for review after the RFC has been accepted.
132+
133+
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.
134+
135+
If you are interested in working on the implementation for an 'active'
136+
RFC, but cannot determine if someone else is already working on it,
137+
feel free to ask (e.g. by leaving a comment on the associated issue).
138+
139+
## Reviewing RFC's
140+
141+
Members of the [core team] will attempt to review some set of open RFC
142+
pull 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.
143+
144+
**Nativescript's RFC process owes its inspiration to the [React RFC process], [Rust RFC process] and [Ember RFC process]**
145+
146+
[Vuejs RFC process]: https://github.com/vuejs/rfcs
147+
[React RFC process]: https://github.com/reactjs/rfcs
148+
[Rust RFC process]: https://github.com/rust-lang/rfcs
149+
[Ember RFC process]: https://github.com/emberjs/rfcs
150+
[Vuejs core team]: https://vuejs.org/v2/guide/team.html

0 commit comments

Comments
 (0)