|
| 1 | +{{ title 'Maintenance intention guidelines' }} |
| 2 | +<div id='crates-heading'> |
| 3 | + {{svg-jar 'circle-with-i'}} |
| 4 | + <h1>Maintenance intention guidelines</h1> |
| 5 | +</div> |
| 6 | + |
| 7 | +<p> |
| 8 | + The maintenance badge is a way for crate maintainers to convey their |
| 9 | + maintenance intentions. The definitions below provide a high level |
| 10 | + categorization. The exact cadence for releases or support provided |
| 11 | + will still vary between crates. Crate maintainers should provide |
| 12 | + further details in their crate's documentation if they wish to |
| 13 | + clarify their intentions or commitments. Crate maintainers should |
| 14 | + refer to the <a href="https://doc.rust-lang.org/cargo/reference/manifest.html">Cargo manifest documentation</a> |
| 15 | + for more information on how to add a maintenance badge. |
| 16 | +</p> |
| 17 | + |
| 18 | +<h2>Categories</h2> |
| 19 | + |
| 20 | +<dl id='maintenance-intentions'> |
| 21 | + <dt>Actively developed<BadgeMaintenance @badge={{hash attributes=(hash status="actively-developed")}} /></dt> |
| 22 | + <dd> |
| 23 | + New features are being added and bugs are being fixed. |
| 24 | + </dd> |
| 25 | + <dt>Passively maintained<BadgeMaintenance @badge={{hash attributes=(hash status="passively-maintained")}} /></dt> |
| 26 | + <dd> |
| 27 | + There are no plans for new features, but the maintainer intends to respond |
| 28 | + to issues that get filed. |
| 29 | + </dd> |
| 30 | + <dt>As-is<BadgeMaintenance @badge={{hash attributes=(hash status="as-is")}} /></dt> |
| 31 | + <dd> |
| 32 | + The crate is feature complete, the maintainer does not intend to continue |
| 33 | + working on it or providing support, but it works for the purposes it was |
| 34 | + designed for. |
| 35 | + </dd> |
| 36 | + <dt>Experimental<BadgeMaintenance @badge={{hash attributes=(hash status="experimental")}} /></dt> |
| 37 | + <dd> |
| 38 | + The author wants to share it with the community but is not intending to meet |
| 39 | + anyone's particular use case. |
| 40 | + </dd> |
| 41 | + <dt>Looking for maintainer<BadgeMaintenance @badge={{hash attributes=(hash status="looking-for-maintainer")}} /></dt> |
| 42 | + <dd> |
| 43 | + The current maintainer would like to transfer the crate to someone else. |
| 44 | + </dd> |
| 45 | + <dt>Deprecated<BadgeMaintenance @badge={{hash attributes=(hash status="deprecated")}} /></dt> |
| 46 | + <dd> |
| 47 | + The maintainer does not recommend using this crate, possibly due there being |
| 48 | + a better solution available or being problems with the crate that they |
| 49 | + do not want to fix. |
| 50 | + </dd> |
| 51 | +</dl> |
0 commit comments