Last active
May 30, 2022 20:12
-
-
Save rusty-snake/574a91f1df9f97ec77ca308d6d731e29 to your computer and use it in GitHub Desktop.
Revisions
-
rusty-snake revised this gist
May 30, 2022 . 1 changed file with 74 additions and 1 deletion.There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode charactersOriginal file line number Diff line number Diff line change @@ -2,7 +2,7 @@ maintenance status ================== [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29)  Proposal to easily show the maintenance status of a project. @@ -30,6 +30,15 @@ for the maintenance status of a project. This project is being actively developed, new features are planned and the maintainer responds to issues/PRs in a reasonable time. | Attribute | Value | | ---------------- | ----- | | New Features | Yes | | Bug fixes | Yes | | Security fixes | Yes | | Answer questions | Yes | | use | Ok | | start use | Ok | ### `passively-maintained` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) @@ -41,6 +50,15 @@ maintainer responds to issues/PRs in a reasonable time. This project is passively maintained, bugs are fixed, but no new features are planned. The maintainer will try to respond to issues/PRs over time. | Attribute | Value | | ---------------- | ----- | | New Features | No | | Bug fixes | Yes | | Security fixes | Yes | | Answer questions | Yes | | use | Ok | | start use | Ok | ### `irregularly-developed` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) @@ -53,6 +71,15 @@ This project is being irregularly developed, new features are planned, bugs are fixed and the maintainer responds to issues/PRs over time. However, this happens only irregularly. | Attribute | Value | | ---------------- | ----- | | New Features | Yes | | Bug fixes | Yes | | Security fixes | Yes | | Answer questions | Yes | | use | Maybe | | start use | Maybe | ### `as-is` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) @@ -68,6 +95,15 @@ MAY still fix security vulnerabilities or answer questions, however there is no guarantee that this will happen. When switching to this status, all known bugs (at this time) SHOULD be documented somewhere. | Attribute | Value | | ---------------- | ----- | | New Features | No | | Bug fixes | No | | Security fixes | Maybe | | Answer questions | Maybe | | use | Ok | | start use | Ok | ### `deprecated` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) @@ -81,6 +117,15 @@ maintainer continues to work on it and it is fine to continue using it for now while you look for or switch to alternatives. Of course, you should not start using this project. | Attribute | Value | | ---------------- | ----- | | New Features | No | | Bug fixes | Yes | | Security fixes | Yes | | Answer questions | Yes | | use | Ok | | start use | No | ### `obsolete` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) @@ -94,6 +139,15 @@ it. The maintainer MAY continue to work on it. The maintainer SHOULD list alternatives and provide instructions for switching to alternatives. | Attribute | Value | | ---------------- | ----- | | New Features | No | | Bug fixes | Maybe | | Security fixes | Maybe | | Answer questions | Maybe | | use | No | | start use | No | ### `personal` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) @@ -105,6 +159,15 @@ alternatives. This is a personal project and not intended to be used by anyone else. Interested people can use it as a reference and pick up parts from it. | Attribute | Value | | ---------------- | ----- | | New Features | Maybe | | Bug fixes | Maybe | | Security fixes | Maybe | | Answer questions | Maybe | | use | No | | start use | No | ### `experimental` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) @@ -115,6 +178,15 @@ Interested people can use it as a reference and pick up parts from it. This project is a technical demonstration and is not intended for serious use. | Attribute | Value | | ---------------- | ----- | | New Features | Maybe | | Bug fixes | Maybe | | Security fixes | Maybe | | Answer questions | Maybe | | use | No | | start use | No | ## Basic usage To apply the basic variant of this proposal, you MUST add a badge to the README @@ -223,6 +295,7 @@ This proposal is heavily inspired by <https://doc.rust-lang.org/cargo/reference/ - 2022-05-30 (3.0.0): redefined experimental as technical demonstration - 2022-05-30 (3.0.0): added personal status - 2022-05-30 (3.0.0): added versioning draft - 2022-05-30 (3.1.0): added attribute tables --- -
May 30, 2022 . 1 changed file with 71 additions and 36 deletions.There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode charactersOriginal file line number Diff line number Diff line change @@ -2,7 +2,7 @@ maintenance status ================== [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29)  Proposal to easily show the maintenance status of a project. @@ -12,8 +12,10 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). ## Motivation You often find interesting projects on Codeberg/GitHub/GitLab but don't know if they are still maintained by anyone. This proposal tries to improve this situation by introducing simple and clearly defined labels for the maintenance status of a project. ## Statuses @@ -59,48 +61,59 @@ only irregularly. [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` The project is feature complete. The maintainer does not intend to continue working on it or providing support. It is perfectly fine to use this project unless you need support or find a bug. The maintainer MAY still fix security vulnerabilities or answer questions, however there is no guarantee that this will happen. When switching to this status, all known bugs (at this time) SHOULD be documented somewhere. ### `deprecated` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` This project is deprecated, it will be obsolete in the future. The maintainer continues to work on it and it is fine to continue using it for now while you look for or switch to alternatives. Of course, you should not start using this project. ### `obsolete` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` This project is obsolete, the maintainer strongly advises against using it. The maintainer MAY continue to work on it. The maintainer SHOULD list alternatives and provide instructions for switching to alternatives. ### `personal` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` This is a personal project and not intended to be used by anyone else. Interested people can use it as a reference and pick up parts from it. ### `experimental` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` This project is a technical demonstration and is not intended for serious use. ## Basic usage @@ -130,9 +143,10 @@ SHOULD be treated according to this table. | `passively-maintained` | `passively-maintained` | `as-is` | | `irregularly-developed` | `irregularly-developed` | `irregularly-developed` | | `as-is` | `as-is` | `as-is` | | `deprecated` | `deprecated` | `obsolete` | | `obsolete` | `obsolete` | `obsolete` | | `personal` | `personal` | `personal` | | `experimental` | `experimental` | `experimental` | ### Badges @@ -160,12 +174,6 @@ SHOULD be treated according to this table. [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown @@ -178,16 +186,43 @@ SHOULD be treated according to this table. [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` ## Versioning <details><summary>Draft</summary> Because the meaning of the different maintenance statuses may change between different versions of this proposal, you should link to the exact reversion you are using. Unresolved: How to provided snippets with the current revision. </details> ## Acknowledgments This proposal is heavily inspired by <https://doc.rust-lang.org/cargo/reference/manifest.html#the-badges-section>. ## Changes - 2021-07-04 (2.0.0): added deprecated status - 2021-07-04 (2.0.0): changed color of passively-maintained from yellowgreen to forestgreen - 2021-07-04 (2.0.0): added irregularly-developed status - 2022-05-30 (3.0.0): reworded Motivation, as-is, deprecated, obsolete - 2022-05-30 (3.0.0): redefined experimental as technical demonstration - 2022-05-30 (3.0.0): added personal status - 2022-05-30 (3.0.0): added versioning draft --- -
Jul 4, 2021 . 1 changed file with 66 additions and 18 deletions.There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode charactersOriginal file line number Diff line number Diff line change @@ -1,21 +1,22 @@ maintenance status ================== [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29)  Proposal to easily show the maintenance status of a project. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). ## Motivation Often you can find interesting projects on GitHub/GitLab, but you don't know if it is still developed/maintained. ## Statuses ### `actively-developed` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) @@ -29,15 +30,27 @@ maintainer responds to issues/PRs in a reasonable time. ### `passively-maintained` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` This project is passively maintained, bugs are fixed, but no new features are planned. The maintainer will try to respond to issues/PRs over time. ### `irregularly-developed` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` This project is being irregularly developed, new features are planned, bugs are fixed and the maintainer responds to issues/PRs over time. However, this happens only irregularly. ### `as-is` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) @@ -62,6 +75,21 @@ to this status, all known bugs (at this time) SHOULD be documented somewhere. This project is experimental, it might not work as expected and should be used with caution. _TODO: Should this status be removed? It says more about the code than about maintenance/development._ ### `deprecated` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` This project is deprecated, it will be obsolete in the future. The maintainer continues working on it and it is OK to keep using if for now while looking for / switching to alternatives. Of course you should not start using this project for new projects. ### `obsolete` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) @@ -96,13 +124,15 @@ If the date is older then three months, you should ask the maintainer to update it (except for `as-is` and `obsolete`). Furthermore, the maintenance status SHOULD be treated according to this table. | stated status | activity in the last month | no activity in the last month | | ----------------------- | -------------------------- | ----------------------------- | | `actively-developed` | `passively-maintained` | `as-is` | | `passively-maintained` | `passively-maintained` | `as-is` | | `irregularly-developed` | `irregularly-developed` | `irregularly-developed` | | `as-is` | `as-is` | `as-is` | | `experimental` | `experimental` | `obsolete` | | `deprecated` | `deprecated` | `obsolete` | | `obsolete` | `obsolete` | `obsolete` | ### Badges @@ -112,10 +142,16 @@ SHOULD be treated according to this table. [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) @@ -130,6 +166,12 @@ SHOULD be treated according to this table. [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown @@ -141,14 +183,20 @@ SHOULD be treated according to this table. This proposal is heavily inspired by <https://doc.rust-lang.org/cargo/reference/manifest.html#the-badges-section>. ## Changes - 2021-07-04 (2.0.0): add deprecated status - 2021-07-04 (2.0.0): change color of passively-maintained from yellowgreen to forestgreen - 2021-07-04 (2.0.0): add irregularly-developed status --- <p> all code snippets are licensed under <a href="https://creativecommons.org/publicdomain/zero/1.0" target="_blank" rel="noopener noreferrer" style="display:inline-block;"> CC0 1.0 <img height="22" src="https://mirrors.creativecommons.org/presskit/icons/cc.png"> <img height="22" src="https://mirrors.creativecommons.org/presskit/icons/zero.png"> </a> </p> -
Jan 8, 2021 .There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode charactersOriginal file line number Diff line number Diff line change @@ -0,0 +1,171 @@ maintenance status ================== [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) Proposal to easily show the maintenance status of a project. ## Motivation Often you can find interesting projects on GitHub/GitLab, but you don't know if it is still developed/maintained. ## Statuses The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). ### `actively-developed` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` This project is being actively developed, new features are planned and the maintainer responds to issues/PRs in a reasonable time. ### `passively-maintained` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` This project is passively maintained, bugs are fixed, but no new features are planned. The maintainer will try to respond to issues/PRs over time. ### `as-is` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` The project is feature complete. The maintainer does not intend to continue working on it or providing support. The maintainer MAY still fix security vulnerabilities, but there is no guarantee that this will happen. When switching to this status, all known bugs (at this time) SHOULD be documented somewhere. ### `experimental` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` This project is experimental, it might not work as expected and should be used with caution. ### `obsolete` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` This project is obsolete, the maintainer strongly advises against using it. He/She MAY continue working on it. The maintainer SHOULD list alternatives and provide guides on how to switch to an alternative. ## Basic usage To apply the basic variant of this proposal, you MUST add a badge to the README of the project indicating the maintenance status. There are two options: * An image like the ones used above. You SHOULD choose this option if the format of your README supports images (e.g. markdown). If you choose this option, you MUST provide a fallback message styled like the second option. * A text message in the form `maintenance-status: <STATUS>` (example: `maintenance-status: actively-developed`). If the format of your README does not support images (e.g. plain text) or a fallback message for images, you MUST choose this option. ## Advanced usage In order to prevent outdated information, it is RECOMMENDED to add a date to the maintenance status. This date SHALL be renewed no later than every three months. If the date is older then three months, you should ask the maintainer to update it (except for `as-is` and `obsolete`). Furthermore, the maintenance status SHOULD be treated according to this table. | stated status | activity in the last month | no activity in the last month | | ---------------------- | -------------------------- | ----------------------------- | | `actively-developed` | `passively-maintained` | `as-is` | | `passively-maintained` | `passively-maintained` | `as-is` | | `as-is` | `as-is` | `as-is` | | `experimental` | `experimental` | `obsolete` | | `obsolete` | `obsolete` | `obsolete` | ### Badges [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ```markdown [](https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29) ``` ## Acknowledgments This proposal is heavily inspired by <https://doc.rust-lang.org/cargo/reference/manifest.html#the-badges-section>. --- <p> all code snippets are licensed under <a href="https://creativecommons.org/publicdomain/zero/1.0" target="_blank" rel="noopener noreferrer" style="display:inline-block;"> CC0 1.0 <img height="22" style="margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.png"> <img height="22" style="margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/zero.png"> </a> </p> <p xmlns:dct="http://purl.org/dc/terms/" xmlns:cc="http://creativecommons.org/ns#"> <a rel="cc:attributionURL" property="dct:title" href="https://gist.github.com/rusty-snake/574a91f1df9f97ec77ca308d6d731e29"> maintenance status </a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/rusty-snake"> rusty-snake </a> is licensed under <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0" target="_blank" rel="license noopener noreferrer" style="display:inline-block;"> CC BY-SA 4.0 <img height="22" src="https://mirrors.creativecommons.org/presskit/icons/cc.png"> <img height="22" src="https://mirrors.creativecommons.org/presskit/icons/by.png"> <img height="22" src="https://mirrors.creativecommons.org/presskit/icons/sa.png"> </a> </p>