rfc:template

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
rfc:template [2011/04/06 10:59] – external edit 127.0.0.1rfc:template [2020/06/28 18:09] (current) – Update version number to 8 girgias
Line 1: Line 1:
-====== Request for Comments: How to write RFCs ====== +====== PHP RFC: Your Title Here ====== 
-  * Version: 1.0 +  * Version: 0.9 
-  * Date: 2008-03-06 +  * Date: 2013-02-24 (use today's date here) 
-  * Author: Stefan Marr <php.at.stefan-marr.de>, Lukas Smith <smith@pooteeweet.org> +  * Author: Your Name, your_email_address@example.com 
-  * Status: Under Discussion +  * Status: Draft (or Under Discussion or Accepted or Declined) 
-  * First Published at: http://wiki.php.net/rfc/traits +  * First Published at: http://wiki.php.net/rfc/your_rfc_name
-  * Other formats ..+
  
 +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!
  
-This RFC is a template other people can use to write their own RFCs.+ 
 +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 
 +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 ===== ===== 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.
 +
 +===== Proposal =====
 +All the features and examples of the proposal.
 +
 +To [[http://news.php.net/php.internals/66051|paraphrase Zeev Suraski]], explain hows the proposal brings substantial value to be considered
 +for inclusion in one of the world's most popular programming languages.
 +
 +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 =====
 +What breaks, and what is the justification for it?
 +
 +===== 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".
 +
 +===== RFC Impact =====
 +==== To SAPIs ====
 +Describe the impact to CLI, Development web server, embedded PHP etc.
 +
 +==== To Existing Extensions ====
 +Will existing extensions be affected?
 +
 +==== To Opcache ====
 +It is necessary to develop RFC's with opcache in mind, since opcache is a core extension distributed with PHP.
  
-The purpose of RFCs are to work collaboratively towards a specification and finally an implementation of an idea.+Please explain how you have verified your RFC's compatibility with opcache.
  
-==== Why do we need RFCs? ====+==== New Constants ==== 
 +Describe any new constants so they can be accurately and comprehensively explained in the PHP documentation.
  
-They serve to keep a summary of on going discussions. This way people can keep an overview of the state of the discussion. Even if never put into place in the end, they also serve as a historical log of discussions that is much easier to read compared to mailinglist threads.+==== php.ini Defaults ==== 
 +If there are any php.ini settings then list: 
 +  * hardcoded default values 
 +  * php.ini-development values 
 +  * php.ini-production values
  
-===== Common Misconceptions =====+===== Open Issues ===== 
 +Make sure there are no open issues when the vote starts!
  
-RFCs do not in any way replace discussions on the mailing list.+===== Unaffected PHP Functionality ===== 
 +List existing areas/features of PHP that will not be changed by the RFC.
  
-===== Proposal and Patch =====+This helps avoid any ambiguity, shows that you have thought deeply about the RFC's impact, and helps reduces mail list noise.
  
-Nothing needs to be patched here. Just use this template at your discretion.+===== Future Scope ===== 
 +This section details areas where the feature might be improved in future, but that are not currently proposed in this RFC.
  
-==== Rejected Features ====+===== Proposed Voting Choices ===== 
 +Include these so readers know where you are heading and can discuss the proposed voting options.
  
-Automated voting system.+===== Patches and Tests ===== 
 +Links to any external patches and tests go here.
  
-==== More about RFCs ====+If there is no patch, make it clear who will create a patch, or whether a volunteer to help with implementation is needed.
  
-http://en.wikipedia.org/wiki/Request_for_Comments+Make it clear if the patch is intended to be the final patch, or is just a prototype.
  
-===== Changelog =====+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 =====
 +Links to external references, discussions or RFCs
  
 +===== Rejected Features =====
 +Keep this updated with features that were discussed on the mail lists.
rfc/template.txt · Last modified: 2020/06/28 18:09 by girgias

Page Tools