commit 48395657c1cc94046c2c2449b95934336c1a177a parent 939278819c136c29029d59941b55b12ecc048bad Author: Alexandre Bique <bique.alexandre@gmail.com> Date: Wed, 20 Dec 2023 11:53:05 +0100 Add a convention file for the extension id Diffstat:
| A | conventions/extension-id.md | | | 23 | +++++++++++++++++++++++ |
1 file changed, 23 insertions(+), 0 deletions(-)
diff --git a/conventions/extension-id.md b/conventions/extension-id.md @@ -0,0 +1,22 @@ +# Extension ID + +## Naming + +The extension shall be named in the form: `clap.$NAME/$REV`. +Where: +- `$NAME` is the name of the exension. +- `$REV` is the revision of the extension. This is an integer that is incremented for each iteration. + +## Draft + +An extension is considered a draft extension if it is in the [draft](../include/clap/ext/draft/) folder. + +When the extension is migrating from draft to stable, its extension ID must not change. + +All extensions must go first though a draft phase. + +## History + +Before this document was written, existing extension didn't honor those rules. +Some stable extension include the string `draft` in their ID. +We decided to keep those in order to maintain the binary compatibility. +\ No newline at end of file