lib/Moose/Manual/Support.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 Moose::Manual::Support - Policies regarding support, releases, and
   6 compatibility.
   7
   8 =head1 SUPPORT POLICY
   9
  10 There are two principles to Moose's policy of supported behavior.
  11
  12 =over 4
  13
  14 =item 1.
  15
  16 Moose favors correctness over everything.
  17
  18 =item 2.
  19
  20 Moose supports documented and tested behavior, not accidental behavior or side
  21 effects.
  22
  23 =back
  24
  25 If a behavior has never been documented or tested, the behavior is
  26 I<officially> undefined. Relying upon undocumented and untested behavior is
  27 done at your own risk.
  28
  29 If a behavior is documented or tested but found to be incorrect later, the
  30 behavior will go through a deprecation period. During the deprecation period,
  31 use of that feature will cause a warning. Eventually, the deprecated feature
  32 will be removed.
  33
  34 In some cases, it is not possible to deprecate a behavior. In this case, the
  35 behavior will simply be changed in a major release.
  36
  37 =head1 RELEASE SCHEDULE
  38
  39 Moose is on a system of quarterly major releases, with minor releases as
  40 needed between major releases. A minor release is defined as one that makes
  41 every attempt to preserve backwards compatibility. Currently this means that we
  42 did not introduce any new dependency conflicts, and that we did not make any
  43 changes to documented or tested behavior (this typically means that minor
  44 releases will not change any existing tests in the test suite, although they
  45 can add new ones). A minor release can include new features and bug fixes.
  46
  47 Major releases may be backwards incompatible. Moose prioritizes
  48 correctness over backwards compatibility or performance; see the L<Deprecation
  49 Policy> to understand how backwards incompatible changes are announced.
  50
  51 Major releases are scheduled to happen during fixed release windows. If the
  52 window is missed, then there will not be a major release until the next
  53 release window. The release windows are one month long, and occur during the
  54 months of January, April, July, and October.
  55
  56 Before a major release, a series of development releases will be made so that
  57 users can test the upcoming major release before it is distributed to CPAN. It
  58 is in the best interests of everyone involved if these releases are tested as
  59 widely as possible.
  60
  61 =head1 DEPRECATION POLICY
  62
  63 Moose has always prioritized correctness over performance and backwards
  64 compatibility.
  65
  66 Major deprecations or API changes are documented in the Changes file as well
  67 as in L<Moose::Manual::Delta>. The Moose developers will also make an effort
  68 to warn users of upcoming deprecations and breakage through the Moose blog
  69 (http://blog.moose.perl.org).
  70
  71 Deprecated APIs will be preserved for at least one year I<after the major
  72 release which deprecates that API>. Deprecated APIs will only be removed in a
  73 major release.
  74
  75 Moose will also warn during installation if the version of Moose being
  76 installed will break an installed dependency. Unfortunately, due to the nature
  77 of the Perl install process these warnings may be easy to miss.
  78
  79 =head1 BACKWARDS COMPATIBILITY
  80
  81 We try to ensure compatibility by having a extensive test suite (last
  82 count just over around 5123 tests), as well as testing a number of
  83 packages (currently just under 100 packages) that depend on Moose before
  84 any release.
  85
  86 The current list of downstream dependencies that are tested is in
  87 C<xt/author/test-my-dependents.t>.
  88
  89 =head1 VERSION NUMBERS
  90
  91 Moose version numbers consist of three parts, in the form X.YYZZ. The X is the
  92 "special magic number" that only gets changed for really big changes. Think of
  93 this as being like the "5" in Perl 5.12.1.
  94
  95 The YY portion is the major version number. Moose uses even numbers for stable
  96 releases, and odd numbers for trial releases. The ZZ is the minor version, and
  97 it simply increases monotonically. It starts at "00" each time a new major
  98 version is released.
  99
 100 Semantically, this means that any two releases which share a major version
 101 should be API-compatible with each other. In other words, 2.0200, 2.0201, and
 102 2.0274 are all API-compatible.
 103
 104 Prior to version 2.0, Moose version numbers were monotonically incrementing
 105 two decimal values (0.01, 0.02, ... 1.11, 1.12, etc.).
 106
 107 Moose was declared production ready at version 0.18 (via L<<
 108 http://www.perlmonks.org/?node_id=608144 >>).
 109
 110 =head1 PERL VERSION COMPATIBILITY
 111
 112 As of version 2.00, Moose officially supports being run on perl 5.8.3+. Our
 113 current policy is to support the earliest version of Perl shipped in the latest
 114 stable release of any major operating system (this tends to mean CentOS). We
 115 will provide at least six months notice (two major releases) when we decide to
 116 increase the officially supported Perl version. The next time this will happen
 117 is in January of 2012, when Moose 2.06 will increase the minimum officially
 118 supported Perl version to 5.10.1.
 119
 120 "Officially supported" does not mean that these are the only versions of Perl
 121 that Moose will work with. Our declared perl dependency will remain at 5.8.3 as
 122 long as our test suite continues to pass on 5.8.3. What this does mean is that
 123 the core Moose dev team will not be spending any time fixing bugs on versions
 124 that aren't officially supported, and new contributions will not be rejected
 125 due to being incompatible with older versions of perl except in the most
 126 trivial of cases. We will, however, still welcome patches to make Moose
 127 compatible with earlier versions, if other people are still interested in
 128 maintaining compatibility. Note that although performance regressions are
 129 acceptable in order to maintain backwards compatibility (as long as they only
 130 affect the older versions), functionality changes and buggy behavior will not
 131 be. If it becomes impossible to provide identical functionality between modern
 132 Perl versions and unsupported Perl versions, we will increase our declared perl
 133 dependency instead.
 134
 135 =head1 CONTRIBUTING
 136
 137 Moose has an open contribution policy. Anybody is welcome to submit a
 138 patch. Please see L<Moose::Manual::Contributing> for more details.
 139
 140 =cut