wiki:TracHacks/DeprecatingHacks

Version 1 (modified by Ryan J Ollos, 10 years ago) (diff)

Document our practices about hack deprecation.

Deprecating Hacks

Hacks may be deprecated if they are superceeded by another hack that is better maintained or provides additional functionality. Hacks may also be deprecated if the plugin is directly integrated to the Trac core, or the Trac core adds equivalent functionality. A list of deprecated hacks can be found here.

Anyone is welcome to maintain a deprecated hack, and the deprecation of a hack is not meant to be an absolute ruling on the fate of a plugin in any official sense. Hack deprecation is usually done for the following reasons:

  • Two or more plugins have equivalent functionality and the maintainers agree to join efforts on a single plugin going forward.
  • The maintainer chooses to deprecate the plugin since there are better choices in the HackIndex.
  • The community managers make their best judgement about a plugin in the case that the maintaininer is no longer reachable, in order to guide users towards the most useful solutions available on the site.

When a hack is deprecated the following notice should be added to the top of the page:

Notice: This plugin is deprecated. <Message here about why the plugin is deprecated>.

{{{#!div class="system-message"
**Notice:** This plugin is deprecated. <Message here about why the plugin is deprecated>.
}}}

The deprecated tag should also be added to the project page.