This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
0364d5c31db22049fda9e12f1f5acad79b166467
[perl5.git] / pod / perlpolicy.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 perlpolicy - Various and sundry policies and commitments related to the Perl core
6
7 =head1 DESCRIPTION
8
9 This document is the master document which records all written
10 policies about how the Perl 5 Porters collectively develop and maintain
11 the Perl core.
12
13 =head1 GOVERNANCE
14
15 =head2 Perl 5 Porters
16
17 Subscribers to perl5-porters (the porters themselves) come in several flavours.
18 Some are quiet curious lurkers, who rarely pitch in and instead watch
19 the ongoing development to ensure they're forewarned of new changes or
20 features in Perl.  Some are representatives of vendors, who are there
21 to make sure that Perl continues to compile and work on their
22 platforms.  Some patch any reported bug that they know how to fix,
23 some are actively patching their pet area (threads, Win32, the regexp
24 -engine), while others seem to do nothing but complain.  In other
25 words, it's your usual mix of technical people.
26
27 Over this group of porters presides Larry Wall.  He has the final word
28 in what does and does not change in any of the Perl programming languages.
29 These days, Larry spends most of his time on Perl 6, while Perl 5 is
30 shepherded by a "pumpking", a porter responsible for deciding what
31 goes into each release and ensuring that releases happen on a regular
32 basis.
33
34 Larry sees Perl development along the lines of the US government:
35 there's the Legislature (the porters), the Executive branch (the
36 -pumpking), and the Supreme Court (Larry).  The legislature can
37 discuss and submit patches to the executive branch all they like, but
38 the executive branch is free to veto them.  Rarely, the Supreme Court
39 will side with the executive branch over the legislature, or the
40 legislature over the executive branch.  Mostly, however, the
41 legislature and the executive branch are supposed to get along and
42 work out their differences without impeachment or court cases.
43
44 You might sometimes see reference to Rule 1 and Rule 2.  Larry's power
45 as Supreme Court is expressed in The Rules:
46
47 =over 4
48
49 =item 1
50
51 Larry is always by definition right about how Perl should behave.
52 This means he has final veto power on the core functionality.
53
54 =item 2
55
56 Larry is allowed to change his mind about any matter at a later date,
57 regardless of whether he previously invoked Rule 1.
58
59 =back
60
61 Got that?  Larry is always right, even when he was wrong.  It's rare
62 to see either Rule exercised, but they are often alluded to.
63
64 =head1 MAINTENANCE AND SUPPORT
65
66 Perl 5 is developed by a community, not a corporate entity. Every change
67 contributed to the Perl core is the result of a donation. Typically, these
68 donations are contributions of code or time by individual members of our
69 community. On occasion, these donations come in the form of corporate
70 or organizational sponsorship of a particular individual or project.
71
72 As a volunteer organization, the commitments we make are heavily dependent
73 on the goodwill and hard work of individuals who have no obligation to
74 contribute to Perl.
75
76 That being said, we value Perl's stability and security and have long
77 had an unwritten covenant with the broader Perl community to support
78 and maintain releases of Perl.
79
80 This document codifies the support and maintenance commitments that
81 the Perl community should expect from Perl's developers:
82
83 =over
84
85 =item *
86
87 We "officially" support the two most recent stable release series.  5.14.x
88 and earlier are now out of support.  As of the release of 5.20.0, we will
89 "officially" end support for Perl 5.16.x, other than providing security
90 updates as described below.
91
92 =item *
93
94 To the best of our ability, we will attempt to fix critical issues
95 in the two most recent stable 5.x release series.  Fixes for the
96 current release series take precedence over fixes for the previous
97 release series.
98
99 =item *
100
101 To the best of our ability, we will provide "critical" security patches
102 / releases for any major version of Perl whose 5.x.0 release was within
103 the past three years.  We can only commit to providing these for the
104 most recent .y release in any 5.x.y series.
105
106 =item *
107
108 We will not provide security updates or bug fixes for development
109 releases of Perl.
110
111 =item *
112
113 We encourage vendors to ship the most recent supported release of
114 Perl at the time of their code freeze.
115
116 =item *
117
118 As a vendor, you may have a requirement to backport security fixes
119 beyond our 3 year support commitment.  We can provide limited support and
120 advice to you as you do so and, where possible will try to apply
121 those patches to the relevant -maint branches in git, though we may or
122 may not choose to make numbered releases or "official" patches
123 available.  Contact us at E<lt>perl5-security-report@perl.orgE<gt>
124 to begin that process.
125
126 =back
127
128 =head1 BACKWARD COMPATIBILITY AND DEPRECATION
129
130 Our community has a long-held belief that backward-compatibility is a
131 virtue, even when the functionality in question is a design flaw.
132
133 We would all love to unmake some mistakes we've made over the past
134 decades.  Living with every design error we've ever made can lead
135 to painful stagnation.  Unwinding our mistakes is very, very
136 difficult.  Doing so without actively harming our users is
137 nearly impossible.
138
139 Lately, ignoring or actively opposing compatibility with earlier versions
140 of Perl has come into vogue.  Sometimes, a change is proposed which
141 wants to usurp syntax which previously had another meaning.  Sometimes,
142 a change wants to improve previously-crazy semantics.
143
144 Down this road lies madness.
145
146 Requiring end-user programmers to change just a few language constructs,
147 even language constructs which no well-educated developer would ever
148 intentionally use is tantamount to saying "you should not upgrade to
149 a new release of Perl unless you have 100% test coverage and can do a
150 full manual audit of your codebase."  If we were to have tools capable of
151 reliably upgrading Perl source code from one version of Perl to another,
152 this concern could be significantly mitigated.
153
154 We want to ensure that Perl continues to grow and flourish in the coming
155 years and decades, but not at the expense of our user community.
156
157 Existing syntax and semantics should only be marked for destruction in
158 very limited circumstances.  If they are believed to be very rarely used,
159 stand in the way of actual improvement to the Perl language or perl
160 interpreter, and if affected code can be easily updated to continue
161 working, they may be considered for removal.  When in doubt, caution
162 dictates that we will favor backward compatibility.  When a feature is
163 deprecated, a statement of reasoning describing the decision process
164 will be posted, and a link to it will be provided in the relevant
165 perldelta documents.
166
167 Using a lexical pragma to enable or disable legacy behavior should be
168 considered when appropriate, and in the absence of any pragma legacy
169 behavior should be enabled.  Which backward-incompatible changes are
170 controlled implicitly by a 'use v5.x.y' is a decision which should be
171 made by the pumpking in consultation with the community.
172
173 Historically, we've held ourselves to a far higher standard than
174 backward-compatibility -- bugward-compatibility.  Any accident of
175 implementation or unintentional side-effect of running some bit of code
176 has been considered to be a feature of the language to be defended with
177 the same zeal as any other feature or functionality.  No matter how
178 frustrating these unintentional features may be to us as we continue
179 to improve Perl, these unintentional features often deserve our
180 protection.  It is very important that existing software written in
181 Perl continue to work correctly.  If end-user developers have adopted a
182 bug as a feature, we need to treat it as such.
183
184 New syntax and semantics which don't break existing language constructs
185 and syntax have a much lower bar.  They merely need to prove themselves
186 to be useful, elegant, well designed, and well tested.  In most cases,
187 these additions will be marked as I<experimental> for some time.  See
188 below for more on that.
189
190 =head2 Terminology
191
192 To make sure we're talking about the same thing when we discuss the removal
193 of features or functionality from the Perl core, we have specific definitions
194 for a few words and phrases.
195
196 =over
197
198 =item experimental
199
200 If something in the Perl core is marked as B<experimental>, we may change
201 its behaviour, deprecate or remove it without notice. While we'll always
202 do our best to smooth the transition path for users of experimental
203 features, you should contact the perl5-porters mailinglist if you find
204 an experimental feature useful and want to help shape its future.
205
206 Experimental features must be experimental in two stable releases before being
207 marked non-experimental.  Experimental features will only have their
208 experimental status revoked when they no longer have any design-changing bugs
209 open against them and when they have remained unchanged in behavior for the
210 entire length of a development cycle.  In other words, a feature present in
211 v5.20.0 may be marked no longer experimental in v5.22.0 if and only if its
212 behavior is unchanged throughout all of v5.21.
213
214 =item deprecated
215
216 If something in the Perl core is marked as B<deprecated>, we may remove it
217 from the core in the future, though we might not.  Generally, backward
218 incompatible changes will have deprecation warnings for two release
219 cycles before being removed, but may be removed after just one cycle if
220 the risk seems quite low or the benefits quite high.
221
222 As of
223 Perl 5.12, deprecated features and modules warn the user as they're used.
224 When a module is deprecated, it will also be made available on CPAN.
225 Installing it from CPAN will silence deprecation warnings for that module.
226
227 If you use a deprecated feature or module and believe that its removal from
228 the Perl core would be a mistake, please contact the perl5-porters
229 mailinglist and plead your case.  We don't deprecate things without a good
230 reason, but sometimes there's a counterargument we haven't considered.
231 Historically, we did not distinguish between "deprecated" and "discouraged"
232 features.
233
234 =item discouraged
235
236 From time to time, we may mark language constructs and features which we
237 consider to have been mistakes as B<discouraged>.  Discouraged features
238 aren't currently candidates for removal, but
239 we may later deprecate them if they're found to stand in the way of a
240 significant improvement to the Perl core.
241
242 =item removed
243
244 Once a feature, construct or module has been marked as deprecated, we
245 may remove it from the Perl core.  Unsurprisingly,
246 we say we've B<removed> these things.  When a module is removed, it will
247 no longer ship with Perl, but will continue to be available on CPAN.
248
249 =back
250
251 =head1 MAINTENANCE BRANCHES
252
253 New releases of maintenance branches should only contain changes that fall into
254 one of the "acceptable" categories set out below, but must not contain any
255 changes that fall into one of the "unacceptable" categories.  (For example, a
256 fix for a crashing bug must not be included if it breaks binary compatibility.)
257
258 It is not necessary to include every change meeting these criteria, and in
259 general the focus should be on addressing security issues, crashing bugs,
260 regressions and serious installation issues.  The temptation to include a
261 plethora of minor changes that don't affect the installation or execution of
262 perl (e.g. spelling corrections in documentation) should be resisted in order
263 to reduce the overall risk of overlooking something.  The intention is to
264 create maintenance releases which are both worthwhile and which users can have
265 full confidence in the stability of.  (A secondary concern is to avoid burning
266 out the maint-pumpking or overwhelming other committers voting on changes to be
267 included (see L</"Getting changes into a maint branch"> below).)
268
269 The following types of change may be considered acceptable, as long as they do
270 not also fall into any of the "unacceptable" categories set out below:
271
272 =over
273
274 =item *
275
276 Patches that fix CVEs or security issues.  These changes should
277 be run through the perl5-security-report@perl.org mailing list
278 rather than applied directly.
279
280 =item *
281
282 Patches that fix crashing bugs, assertion failures and
283 memory corruption but which do not otherwise change perl's
284 functionality or negatively impact performance.
285
286 =item *
287
288 Patches that fix regressions in perl's behavior relative to previous
289 releases, no matter how old the regression, since some people may
290 upgrade from very old versions of perl to the latest version.
291
292 =item *
293
294 Patches that fix anything which prevents or seriously impacts the build
295 or installation of perl.
296
297 =item *
298
299 Portability fixes, such as changes to Configure and the files in
300 the hints/ folder.
301
302 =item *
303
304 Minimal patches that fix platform-specific test failures.
305
306 =item *
307
308 Documentation updates that correct factual errors, explain significant
309 bugs or deficiencies in the current implementation, or fix broken markup.
310
311 =item *
312
313 Updates to dual-life modules should consist of minimal patches to
314 fix crashing bugs or security issues (as above).  Any changes made to
315 dual-life modules for which CPAN is canonical should be coordinated with
316 the upstream author.
317
318 =back
319
320 The following types of change are NOT acceptable:
321
322 =over
323
324 =item *
325
326 Patches that break binary compatibility.  (Please talk to a pumpking.)
327
328 =item *
329
330 Patches that add or remove features.
331
332 =item *
333
334 Patches that add new warnings or errors or deprecate features.
335
336 =item *
337
338 Ports of Perl to a new platform, architecture or OS release that
339 involve changes to the implementation.
340
341 =item *
342
343 New versions of dual-life modules should NOT be imported into maint.
344 Those belong in the next stable series.
345
346 =back
347
348 If there is any question about whether a given patch might merit
349 inclusion in a maint release, then it almost certainly should not
350 be included.
351
352 =head2 Getting changes into a maint branch
353
354 Historically, only the pumpking cherry-picked changes from bleadperl
355 into maintperl.  This has scaling problems.  At the same time,
356 maintenance branches of stable versions of Perl need to be treated with
357 great care. To that end, as of Perl 5.12, we have a new process for
358 maint branches.
359
360 Any committer may cherry-pick any commit from blead to a maint branch if
361 they send mail to perl5-porters announcing their intent to cherry-pick
362 a specific commit along with a rationale for doing so and at least two
363 other committers respond to the list giving their assent. (This policy
364 applies to current and former pumpkings, as well as other committers.)
365
366 =head1 CONTRIBUTED MODULES
367
368
369 =head2 A Social Contract about Artistic Control
370
371 What follows is a statement about artistic control, defined as the ability
372 of authors of packages to guide the future of their code and maintain
373 control over their work.  It is a recognition that authors should have
374 control over their work, and that it is a responsibility of the rest of
375 the Perl community to ensure that they retain this control.  It is an
376 attempt to document the standards to which we, as Perl developers, intend
377 to hold ourselves.  It is an attempt to write down rough guidelines about
378 the respect we owe each other as Perl developers.
379
380 This statement is not a legal contract.  This statement is not a legal
381 document in any way, shape, or form.  Perl is distributed under the GNU
382 Public License and under the Artistic License; those are the precise legal
383 terms.  This statement isn't about the law or licenses.  It's about
384 community, mutual respect, trust, and good-faith cooperation.
385
386 We recognize that the Perl core, defined as the software distributed with
387 the heart of Perl itself, is a joint project on the part of all of us.
388 From time to time, a script, module, or set of modules (hereafter referred
389 to simply as a "module") will prove so widely useful and/or so integral to
390 the correct functioning of Perl itself that it should be distributed with
391 the Perl core.  This should never be done without the author's explicit
392 consent, and a clear recognition on all parts that this means the module
393 is being distributed under the same terms as Perl itself.  A module author
394 should realize that inclusion of a module into the Perl core will
395 necessarily mean some loss of control over it, since changes may
396 occasionally have to be made on short notice or for consistency with the
397 rest of Perl.
398
399 Once a module has been included in the Perl core, however, everyone
400 involved in maintaining Perl should be aware that the module is still the
401 property of the original author unless the original author explicitly
402 gives up their ownership of it.  In particular:
403
404 =over
405
406 =item *
407
408 The version of the module in the Perl core should still be considered the
409 work of the original author.  All patches, bug reports, and so
410 forth should be fed back to them.  Their development directions
411 should be respected whenever possible.
412
413 =item *
414
415 Patches may be applied by the pumpkin holder without the explicit
416 cooperation of the module author if and only if they are very minor,
417 time-critical in some fashion (such as urgent security fixes), or if
418 the module author cannot be reached.  Those patches must still be
419 given back to the author when possible, and if the author decides on
420 an alternate fix in their version, that fix should be strongly
421 preferred unless there is a serious problem with it.  Any changes not
422 endorsed by the author should be marked as such, and the contributor
423 of the change acknowledged.
424
425 =item *
426
427 The version of the module distributed with Perl should, whenever
428 possible, be the latest version of the module as distributed by the
429 author (the latest non-beta version in the case of public Perl
430 releases), although the pumpkin holder may hold off on upgrading the
431 version of the module distributed with Perl to the latest version
432 until the latest version has had sufficient testing.
433
434 =back
435
436 In other words, the author of a module should be considered to have final
437 say on modifications to their module whenever possible (bearing in mind
438 that it's expected that everyone involved will work together and arrive at
439 reasonable compromises when there are disagreements).
440
441 As a last resort, however:
442
443
444 If the author's vision of the future of their module is sufficiently
445 different from the vision of the pumpkin holder and perl5-porters as a
446 whole so as to cause serious problems for Perl, the pumpkin holder may
447 choose to formally fork the version of the module in the Perl core from the
448 one maintained by the author.  This should not be done lightly and
449 should B<always> if at all possible be done only after direct input
450 from Larry.  If this is done, it must then be made explicit in the
451 module as distributed with the Perl core that it is a forked version and
452 that while it is based on the original author's work, it is no longer
453 maintained by them.  This must be noted in both the documentation and
454 in the comments in the source of the module.
455
456 Again, this should be a last resort only.  Ideally, this should never
457 happen, and every possible effort at cooperation and compromise should be
458 made before doing this.  If it does prove necessary to fork a module for
459 the overall health of Perl, proper credit must be given to the original
460 author in perpetuity and the decision should be constantly re-evaluated to
461 see if a remerging of the two branches is possible down the road.
462
463 In all dealings with contributed modules, everyone maintaining Perl should
464 keep in mind that the code belongs to the original author, that they may
465 not be on perl5-porters at any given time, and that a patch is not
466 official unless it has been integrated into the author's copy of the
467 module.  To aid with this, and with points #1, #2, and #3 above, contact
468 information for the authors of all contributed modules should be kept with
469 the Perl distribution.
470
471 Finally, the Perl community as a whole recognizes that respect for
472 ownership of code, respect for artistic control, proper credit, and active
473 effort to prevent unintentional code skew or communication gaps is vital
474 to the health of the community and Perl itself.  Members of a community
475 should not normally have to resort to rules and laws to deal with each
476 other, and this document, although it contains rules so as to be clear, is
477 about an attitude and general approach.  The first step in any dispute
478 should be open communication, respect for opposing views, and an attempt
479 at a compromise.  In nearly every circumstance nothing more will be
480 necessary, and certainly no more drastic measure should be used until
481 every avenue of communication and discussion has failed.
482
483
484 =head1 DOCUMENTATION
485
486 Perl's documentation is an important resource for our users. It's
487 incredibly important for Perl's documentation to be reasonably coherent
488 and to accurately reflect the current implementation.
489
490 Just as P5P collectively maintains the codebase, we collectively
491 maintain the documentation.  Writing a particular bit of documentation
492 doesn't give an author control of the future of that documentation.
493 At the same time, just as source code changes should match the style
494 of their surrounding blocks, so should documentation changes.
495
496 Examples in documentation should be illustrative of the concept
497 they're explaining.  Sometimes, the best way to show how a
498 language feature works is with a small program the reader can
499 run without modification.  More often, examples will consist
500 of a snippet of code containing only the "important" bits.
501 The definition of "important" varies from snippet to snippet.
502 Sometimes it's important to declare C<use strict> and C<use warnings>,
503 initialize all variables and fully catch every error condition.
504 More often than not, though, those things obscure the lesson
505 the example was intended to teach.
506
507 As Perl is developed by a global team of volunteers, our
508 documentation often contains spellings which look funny
509 to I<somebody>.  Choice of American/British/Other spellings
510 is left as an exercise for the author of each bit of
511 documentation.  When patching documentation, try to emulate
512 the documentation around you, rather than changing the existing
513 prose.
514
515 In general, documentation should describe what Perl does "now" rather
516 than what it used to do.  It's perfectly reasonable to include notes
517 in documentation about how behaviour has changed from previous releases,
518 but, with very few exceptions, documentation isn't "dual-life" --
519 it doesn't need to fully describe how all old versions used to work.
520
521 =head1 STANDARDS OF CONDUCT
522
523 The official forum for the development of perl is the perl5-porters mailing
524 list, mentioned above, and its bugtracker at rt.perl.org.  All participants in
525 discussion there are expected to adhere to a standard of conduct.
526
527 =over 4
528
529 =item *
530
531 Always be civil.
532
533 =item * 
534
535 Heed the moderators.
536
537 =back
538
539 Civility is simple:  stick to the facts while avoiding demeaning remarks and
540 sarcasm.  It is not enough to be factual.  You must also be civil.  Responding
541 in kind to incivility is not acceptable.
542
543 If the list moderators tell you that you are not being civil, carefully
544 consider how your words have appeared before responding in any way.  You may
545 protest, but repeated protest in the face of a repeatedly reaffirmed decision
546 is not acceptable.
547
548 Unacceptable behavior will result in a public and clearly identified warning.
549 Repeated unacceptable behavior will result in removal from the mailing list and
550 revocation of rights to update rt.perl.org.  The first removal is for one
551 month.  Subsequent removals will double in length.  After six months with no
552 warning, a user's ban length is reset.  Removals, like warnings, are public.
553
554 The list of moderators will be public knowledge.  At present, it is:
555 Aaron Crane, Andy Dougherty, Ricardo Signes, Steffen Müller.
556
557 =head1 CREDITS
558
559 "Social Contract about Contributed Modules" originally by Russ Allbery E<lt>rra@stanford.eduE<gt> and the perl5-porters.
560