rfc:template
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
rfc:template [2013/02/14 20:53] – Add versions and mention doc (suggestions from #php.doc) sixd | rfc:template [2017/09/22 13:28] – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | |||
====== PHP RFC: Your Title Here ====== | ====== PHP RFC: Your Title Here ====== | ||
* Version: 0.9 | * Version: 0.9 | ||
- | * Date: 2013-02-14 (use today' | + | * Date: 2013-02-24 (use today' |
* Author: Your Name, your_email_address@example.com | * Author: Your Name, your_email_address@example.com | ||
* Status: Draft (or Under Discussion or Accepted or Declined) | * Status: Draft (or Under Discussion or Accepted or Declined) | ||
Line 8: | Line 7: | ||
This is a suggested template for PHP Request for Comments (RFCs). Change this template to suit your RFC. Not all RFCs need to be tightly specified. | This is a suggested template for PHP Request for Comments (RFCs). Change this template to suit your RFC. Not all RFCs need to be tightly specified. | ||
+ | Read https:// | ||
- | ===== Introduction ===== | ||
- | The elevator pitch for the RFC. | + | Quoting [[http:// |
- | ===== Proposal ===== | + | > PHP is and should remain: |
+ | > 1) a pragmatic web-focused language | ||
+ | > 2) a loosely typed language | ||
+ | > 3) a language which caters to the skill-levels and platforms of a wide range of users | ||
+ | Your RFC should move PHP forward following his vision. As [[http:// | ||
+ | large chunk of our userbase, and not something that could be useful in some | ||
+ | extremely specialized edge cases [...] Make sure you think about the full context, the huge audience out there, the consequences of making the learning curve steeper with | ||
+ | every new feature, and the scope of the goodness that those new features bring." | ||
+ | |||
+ | ===== Introduction ===== | ||
+ | The elevator pitch for the RFC. The first paragraph in this section will be slightly larger to give it emphasis; please write a good introduction. | ||
+ | |||
+ | ===== Proposal ===== | ||
All the features and examples of the proposal. | All the features and examples of the proposal. | ||
+ | |||
+ | To [[http:// | ||
+ | for inclusion in one of the world' | ||
Remember that the RFC contents should be easily reusable in the PHP Documentation. | Remember that the RFC contents should be easily reusable in the PHP Documentation. | ||
- | ===== Backward Incompatible Changes ===== | + | If applicable, you may wish to use the language specification as a reference. |
+ | ===== Backward Incompatible Changes ===== | ||
What breaks, and what is the justification for it? | What breaks, and what is the justification for it? | ||
===== Proposed PHP Version(s) ===== | ===== Proposed PHP Version(s) ===== | ||
+ | List the proposed PHP versions that the feature will be included in. Use relative versions such as "next PHP 7.x" or "next PHP 7.x.y" | ||
- | List the proposed PHP versions that the feature will be included in. Use relative versions such as "next PHP 5.x" or "next PHP 5.x.y" | + | ===== RFC Impact |
- | + | ==== To SAPIs ==== | |
- | ===== SAPIs Impacted | + | |
Describe the impact to CLI, Development web server, embedded PHP etc. | Describe the impact to CLI, Development web server, embedded PHP etc. | ||
- | ===== Impact to Existing Extensions ===== | + | ==== To Existing Extensions ==== |
Will existing extensions be affected? | Will existing extensions be affected? | ||
- | ===== php.ini Defaults ===== | + | ==== To Opcache |
+ | It is necessary to develop RFC's with opcache in mind, since opcache is a core extension distributed with PHP. | ||
- | If there are any php.ini settings list: | + | Please explain how you have verified your RFC's compatibility with opcache. |
+ | |||
+ | ==== New Constants ==== | ||
+ | Describe any new constants so they can be accurately and comprehensively explained in the PHP documentation. | ||
+ | |||
+ | ==== php.ini Defaults ==== | ||
+ | If there are any php.ini settings | ||
* hardcoded default values | * hardcoded default values | ||
* php.ini-development values | * php.ini-development values | ||
Line 43: | Line 63: | ||
===== Open Issues ===== | ===== Open Issues ===== | ||
- | |||
Make sure there are no open issues when the vote starts! | Make sure there are no open issues when the vote starts! | ||
- | ===== Future Scope ===== | + | ===== Unaffected PHP Functionality |
+ | List existing areas/ | ||
+ | This helps avoid any ambiguity, shows that you have thought deeply about the RFC's impact, and helps reduces mail list noise. | ||
+ | |||
+ | ===== Future Scope ===== | ||
This sections details areas where the feature might be improved in future, but that are not currently proposed in this RFC. | This sections details areas where the feature might be improved in future, but that are not currently proposed in this RFC. | ||
===== Proposed Voting Choices ===== | ===== Proposed Voting Choices ===== | ||
+ | Include these so readers know where you are heading and can discuss the proposed voting options. | ||
- | Include these so readers know where you are heading and can dicuss the proposed | + | State whether this project requires a 2/3 or 50%+1 majority (see [[voting]]) |
===== Patches and Tests ===== | ===== Patches and Tests ===== | ||
+ | Links to any external patches and tests go here. | ||
- | Links to any external patches and tests | + | If there is no patch, make it clear who will create a patch, or whether a volunteer |
- | ===== References ===== | + | Make it clear if the patch is intended to be the final patch, or is just a prototype. |
+ | For changes affecting the core language, you should also provide a patch for the language specification. | ||
+ | |||
+ | ===== Implementation ===== | ||
+ | After the project is implemented, | ||
+ | - the version(s) it was merged to | ||
+ | - a link to the git commit(s) | ||
+ | - a link to the PHP manual entry for the feature | ||
+ | - a link to the language specification section (if any) | ||
+ | |||
+ | ===== References ===== | ||
Links to external references, discussions or RFCs | Links to external references, discussions or RFCs | ||
===== Rejected Features ===== | ===== Rejected Features ===== | ||
- | |||
Keep this updated with features that were discussed on the mail lists. | Keep this updated with features that were discussed on the mail lists. | ||
- | |||
- |
rfc/template.txt · Last modified: 2020/06/28 18:09 by girgias