-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a convention file for the extension id
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 characters
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. |