rfc:template

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
rfc:template [2013/02/24 21:55]
bjori See if I've fixed our capabilities of modifying the actual template
rfc:template [2020/06/28 18:09] (current)
girgias Update version number to 8
Line 1: Line 1:
- 
 ====== PHP RFC: Your Title Here ====== ====== PHP RFC: Your Title Here ======
   * Version: 0.9   * Version: 0.9
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.  Not all RFCs need all the sections below. 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.  Not all RFCs need all the sections below.
 +Read https://wiki.php.net/rfc/howto carefully!
  
-You RFC should move PHP forward. As [[http://news.php.net/php.internals/66065|said by Zeev Suraski]] "Consider only features which have significant traction to a+ 
 +Quoting [[http://news.php.net/php.internals/71525|Rasmus]]: 
 + 
 +> 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://news.php.net/php.internals/66065|said by Zeev Suraski]] "Consider only features which have significant traction to a
 large chunk of our userbase, and not something that could be useful in some 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 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." every new feature, and the scope of the goodness that those new features bring."
 +
 ===== Introduction ===== ===== Introduction =====
- +The elevator pitch for the RFC. The first paragraph of this section will be slightly larger to give it emphasis; please write a good introduction.
-The elevator pitch for the RFC.+
  
 ===== Proposal ===== ===== Proposal =====
- 
 All the features and examples of the proposal. All the features and examples of the proposal.
  
Line 25: Line 32:
  
 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.
 +
 +If applicable, you may wish to use the language specification as a reference.
 +
 ===== Backward Incompatible Changes ===== ===== 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 8.x" or "next PHP 8.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?
  
-===== New Constants =====+==== To Opcache ==== 
 +It is necessary to develop RFC's with opcache in mind, since opcache is a core extension distributed with PHP.
  
-Describe any new constants so they can be accurately and comprehensively explained in the PHP documentation.+Please explain how you have verified your RFC's compatibility with opcache.
  
-===== php.ini Defaults =====+==== 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 then list: If there are any php.ini settings then list:
   * hardcoded default values   * hardcoded default values
Line 53: 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!
  
 ===== Unaffected PHP Functionality ===== ===== Unaffected PHP Functionality =====
- 
 List existing areas/features of PHP that will not be changed by the RFC. List existing areas/features of PHP that will not be changed by the RFC.
  
Line 63: Line 71:
  
 ===== Future Scope ===== ===== Future Scope =====
- +This section 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 discuss the proposed voting options.
  
 ===== Patches and Tests ===== ===== Patches and Tests =====
- 
 Links to any external patches and tests go here. Links to any external patches and tests go here.
  
Line 77: Line 82:
  
 Make it clear if the patch is intended to be the final patch, or is just a prototype. 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, this section should contain 
 +  - the version(s) it was merged into
 +  - 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 ===== ===== 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.1361742942.txt.gz · Last modified: 2017/09/22 13:28 (external edit)