Skip to content

Commit

Permalink
Add a convention file for the extension id
Browse files Browse the repository at this point in the history
  • Loading branch information
abique committed Dec 20, 2023
1 parent 9392788 commit 4839565
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions conventions/extension-id.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 4839565

Please sign in to comment.