Also: [Productionisation checklist](PRODUCTIONISATION-CHECKLIST.md) # stability-badges Software stability badges and their definitions. ### Work in progress [![stability-wip](https://img.shields.io/badge/stability-wip-lightgrey.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#work-in-progress) Code is a 'work in progress' and is not ready for public use. ```markdown [![stability-wip](https://img.shields.io/badge/stability-wip-lightgrey.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#work-in-progress) ``` ```html WIP ``` ### Deprecated [![stability-deprecated](https://img.shields.io/badge/stability-deprecated-922b21.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#deprecated) Code changes are planned. Do not rely on the current functionlity. Use of the feature may cause warnings. Backwards compatibility should not be expected. ```markdown [![stability-deprecated](https://img.shields.io/badge/stability-deprecated-922b21.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#deprecated) ``` ```html Deprecated ``` ### Experimental [![stability-experimental](https://img.shields.io/badge/stability-experimental-orange.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#experimental) Code is new and may change or be removed in future versions. Please try it out and provide feedback. If it addresses a use-case that is important to you please open an issue to discuss it further. ```markdown [![stability-experimental](https://img.shields.io/badge/stability-experimental-orange.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#experimental) ``` ```html Experimental ``` ### Alpha [![stability-alpha](https://img.shields.io/badge/stability-alpha-f4d03f.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#alpha) Code is functional but volatile and prone to breaking changes. Feature development is in progress and solutions are being validated. ```markdown [![stability-alpha](https://img.shields.io/badge/stability-alpha-f4d03f.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#alpha) ``` ```html Alpha ``` ### Beta [![stability-beta](https://img.shields.io/badge/stability-beta-33bbff.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#beta) Code is in the process of settling, but has not yet had sufficient real-world testing to be considered mature. Backwards-compatibility will be maintained if reasonable. See also, the [productionisation checklist](PRODUCTIONISATION-CHECKLIST.md). ```markdown [![stability-beta](https://img.shields.io/badge/stability-beta-33bbff.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#beta) ``` ```html Beta ``` ### Release Candidate [![stability-release-candidate](https://img.shields.io/badge/stability-pre--release-48c9b0.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#release-candidate) Code is fairly settled and is in use in production systems. Backwards-compatibility will be mintained unless serious issues are discovered and consensus on a better solution is reached. ```markdown [![stability-release-candidate](https://img.shields.io/badge/stability-pre--release-48c9b0.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#release-candidate) ``` ```html Release Candidate ``` ### Mature [![stability-mature](https://img.shields.io/badge/stability-mature-008000.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#mature) Code has proven satisfactory and is ready for production use, cleanup of the underlying code may cause some minor changes. Backwards-compatibility is guaranteed. ```markdown [![stability-mature](https://img.shields.io/badge/stability-mature-008000.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#mature) ``` ```html Mature ``` ### Frozen [![stability-frozen](https://img.shields.io/badge/stability-frozen-0000CD.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#frozen) Code has been tested extensively in production and is unlikely to ever need to change. ```markdown [![stability-frozen](https://img.shields.io/badge/stability-frozen-0000CD.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#frozen) ``` ```html Frozen ``` ### Locked [![stability-locked](https://img.shields.io/badge/stability-locked-4b0088.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#locked) Code is complete. Unless serious bugs are found, this software will not ever change. ```markdown [![stability-locked](https://img.shields.io/badge/stability-locked-4b0088.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#locked) ``` ```html Locked ``` ## Credits https://github.com/orangemug/stability-badges adapted for my own projects.