This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
maint policy: Put notes about CPAN modules in one place
[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 maint should contain as few changes as possible.
254 If there is any question about whether a given patch might merit
255 inclusion in a maint release, then it almost certainly should not
256 be included.
257
258 The following types of change may be considered acceptable, as long as they do
259 not also fall into any of the "unacceptable" categories set out below:
260
261 =over
262
263 =item *
264
265 Patches that fix CVEs or security issues.  These changes should
266 be run through the perl5-security-report@perl.org mailing list
267 rather than applied directly.
268
269 =item *
270
271 Patches that fix crashing bugs, assertion failures and
272 memory corruption that do not otherwise change Perl's
273 functionality or negatively impact performance.
274
275 =item *
276
277 Patches that fix regressions in perl's behavior relative to previous
278 releases.
279
280 =item *
281
282 Portability fixes, such as changes to Configure and the files in
283 the hints/ folder.
284
285 =item *
286
287 Minimal patches that fix platform-specific test failures or build or
288 installation issues.
289
290 =item *
291
292 Documentation updates that correct factual errors, explain significant
293 bugs or deficiencies in the current implementation, or fix broken markup.
294
295 =item *
296
297 Updates to dual-life modules should consist of minimal patches to
298 fix crashing bugs or security issues (as above).  Any changes made to
299 dual-life modules for which CPAN is canonical should be coordinated with
300 the upstream author.
301
302 =back
303
304 The following types of change are NOT acceptable:
305
306 =over
307
308 =item *
309
310 Patches that break binary compatibility.  (Please talk to a pumpking.)
311
312 =item *
313
314 Patches that add or remove features.
315
316 =item *
317
318 Patches that add new warnings or errors or deprecate features.
319
320 =item *
321
322 Ports of Perl to a new platform, architecture or OS release that
323 involve changes to the implementation.
324
325 =item *
326
327 New versions of dual-life modules should NOT be imported into maint.
328 Those belong in the next stable series.
329
330 =back
331
332 =head2 Getting changes into a maint branch
333
334 Historically, only the pumpking cherry-picked changes from bleadperl
335 into maintperl.  This has scaling problems.  At the same time,
336 maintenance branches of stable versions of Perl need to be treated with
337 great care. To that end, as of Perl 5.12, we have a new process for
338 maint branches.
339
340 Any committer may cherry-pick any commit from blead to a maint branch if
341 they send mail to perl5-porters announcing their intent to cherry-pick
342 a specific commit along with a rationale for doing so and at least two
343 other committers respond to the list giving their assent. (This policy
344 applies to current and former pumpkings, as well as other committers.)
345
346 =head1 CONTRIBUTED MODULES
347
348
349 =head2 A Social Contract about Artistic Control
350
351 What follows is a statement about artistic control, defined as the ability
352 of authors of packages to guide the future of their code and maintain
353 control over their work.  It is a recognition that authors should have
354 control over their work, and that it is a responsibility of the rest of
355 the Perl community to ensure that they retain this control.  It is an
356 attempt to document the standards to which we, as Perl developers, intend
357 to hold ourselves.  It is an attempt to write down rough guidelines about
358 the respect we owe each other as Perl developers.
359
360 This statement is not a legal contract.  This statement is not a legal
361 document in any way, shape, or form.  Perl is distributed under the GNU
362 Public License and under the Artistic License; those are the precise legal
363 terms.  This statement isn't about the law or licenses.  It's about
364 community, mutual respect, trust, and good-faith cooperation.
365
366 We recognize that the Perl core, defined as the software distributed with
367 the heart of Perl itself, is a joint project on the part of all of us.
368 From time to time, a script, module, or set of modules (hereafter referred
369 to simply as a "module") will prove so widely useful and/or so integral to
370 the correct functioning of Perl itself that it should be distributed with
371 the Perl core.  This should never be done without the author's explicit
372 consent, and a clear recognition on all parts that this means the module
373 is being distributed under the same terms as Perl itself.  A module author
374 should realize that inclusion of a module into the Perl core will
375 necessarily mean some loss of control over it, since changes may
376 occasionally have to be made on short notice or for consistency with the
377 rest of Perl.
378
379 Once a module has been included in the Perl core, however, everyone
380 involved in maintaining Perl should be aware that the module is still the
381 property of the original author unless the original author explicitly
382 gives up their ownership of it.  In particular:
383
384 =over
385
386 =item *
387
388 The version of the module in the Perl core should still be considered the
389 work of the original author.  All patches, bug reports, and so
390 forth should be fed back to them.  Their development directions
391 should be respected whenever possible.
392
393 =item *
394
395 Patches may be applied by the pumpkin holder without the explicit
396 cooperation of the module author if and only if they are very minor,
397 time-critical in some fashion (such as urgent security fixes), or if
398 the module author cannot be reached.  Those patches must still be
399 given back to the author when possible, and if the author decides on
400 an alternate fix in their version, that fix should be strongly
401 preferred unless there is a serious problem with it.  Any changes not
402 endorsed by the author should be marked as such, and the contributor
403 of the change acknowledged.
404
405 =item *
406
407 The version of the module distributed with Perl should, whenever
408 possible, be the latest version of the module as distributed by the
409 author (the latest non-beta version in the case of public Perl
410 releases), although the pumpkin holder may hold off on upgrading the
411 version of the module distributed with Perl to the latest version
412 until the latest version has had sufficient testing.
413
414 =back
415
416 In other words, the author of a module should be considered to have final
417 say on modifications to their module whenever possible (bearing in mind
418 that it's expected that everyone involved will work together and arrive at
419 reasonable compromises when there are disagreements).
420
421 As a last resort, however:
422
423
424 If the author's vision of the future of their module is sufficiently
425 different from the vision of the pumpkin holder and perl5-porters as a
426 whole so as to cause serious problems for Perl, the pumpkin holder may
427 choose to formally fork the version of the module in the Perl core from the
428 one maintained by the author.  This should not be done lightly and
429 should B<always> if at all possible be done only after direct input
430 from Larry.  If this is done, it must then be made explicit in the
431 module as distributed with the Perl core that it is a forked version and
432 that while it is based on the original author's work, it is no longer
433 maintained by them.  This must be noted in both the documentation and
434 in the comments in the source of the module.
435
436 Again, this should be a last resort only.  Ideally, this should never
437 happen, and every possible effort at cooperation and compromise should be
438 made before doing this.  If it does prove necessary to fork a module for
439 the overall health of Perl, proper credit must be given to the original
440 author in perpetuity and the decision should be constantly re-evaluated to
441 see if a remerging of the two branches is possible down the road.
442
443 In all dealings with contributed modules, everyone maintaining Perl should
444 keep in mind that the code belongs to the original author, that they may
445 not be on perl5-porters at any given time, and that a patch is not
446 official unless it has been integrated into the author's copy of the
447 module.  To aid with this, and with points #1, #2, and #3 above, contact
448 information for the authors of all contributed modules should be kept with
449 the Perl distribution.
450
451 Finally, the Perl community as a whole recognizes that respect for
452 ownership of code, respect for artistic control, proper credit, and active
453 effort to prevent unintentional code skew or communication gaps is vital
454 to the health of the community and Perl itself.  Members of a community
455 should not normally have to resort to rules and laws to deal with each
456 other, and this document, although it contains rules so as to be clear, is
457 about an attitude and general approach.  The first step in any dispute
458 should be open communication, respect for opposing views, and an attempt
459 at a compromise.  In nearly every circumstance nothing more will be
460 necessary, and certainly no more drastic measure should be used until
461 every avenue of communication and discussion has failed.
462
463
464 =head1 DOCUMENTATION
465
466 Perl's documentation is an important resource for our users. It's
467 incredibly important for Perl's documentation to be reasonably coherent
468 and to accurately reflect the current implementation.
469
470 Just as P5P collectively maintains the codebase, we collectively
471 maintain the documentation.  Writing a particular bit of documentation
472 doesn't give an author control of the future of that documentation.
473 At the same time, just as source code changes should match the style
474 of their surrounding blocks, so should documentation changes.
475
476 Examples in documentation should be illustrative of the concept
477 they're explaining.  Sometimes, the best way to show how a
478 language feature works is with a small program the reader can
479 run without modification.  More often, examples will consist
480 of a snippet of code containing only the "important" bits.
481 The definition of "important" varies from snippet to snippet.
482 Sometimes it's important to declare C<use strict> and C<use warnings>,
483 initialize all variables and fully catch every error condition.
484 More often than not, though, those things obscure the lesson
485 the example was intended to teach.
486
487 As Perl is developed by a global team of volunteers, our
488 documentation often contains spellings which look funny
489 to I<somebody>.  Choice of American/British/Other spellings
490 is left as an exercise for the author of each bit of
491 documentation.  When patching documentation, try to emulate
492 the documentation around you, rather than changing the existing
493 prose.
494
495 In general, documentation should describe what Perl does "now" rather
496 than what it used to do.  It's perfectly reasonable to include notes
497 in documentation about how behaviour has changed from previous releases,
498 but, with very few exceptions, documentation isn't "dual-life" --
499 it doesn't need to fully describe how all old versions used to work.
500
501 =head1 STANDARDS OF CONDUCT
502
503 The official forum for the development of perl is the perl5-porters mailing
504 list, mentioned above, and its bugtracker at rt.perl.org.  All participants in
505 discussion there are expected to adhere to a standard of conduct.
506
507 =over 4
508
509 =item *
510
511 Always be civil.
512
513 =item * 
514
515 Heed the moderators.
516
517 =back
518
519 Civility is simple:  stick to the facts while avoiding demeaning remarks and
520 sarcasm.  It is not enough to be factual.  You must also be civil.  Responding
521 in kind to incivility is not acceptable.
522
523 If the list moderators tell you that you are not being civil, carefully
524 consider how your words have appeared before responding in any way.  You may
525 protest, but repeated protest in the face of a repeatedly reaffirmed decision
526 is not acceptable.
527
528 Unacceptable behavior will result in a public and clearly identified warning.
529 Repeated unacceptable behavior will result in removal from the mailing list and
530 revocation of rights to update rt.perl.org.  The first removal is for one
531 month.  Subsequent removals will double in length.  After six months with no
532 warning, a user's ban length is reset.  Removals, like warnings, are public.
533
534 The list of moderators will be public knowledge.  At present, it is:
535 Aaron Crane, Andy Dougherty, Ricardo Signes, Steffen Müller.
536
537 =head1 CREDITS
538
539 "Social Contract about Contributed Modules" originally by Russ Allbery E<lt>rra@stanford.eduE<gt> and the perl5-porters.
540