diff --git a/documentation/prototypes.md b/documentation/prototypes.md index d8d5ba76c..a748f46be 100644 --- a/documentation/prototypes.md +++ b/documentation/prototypes.md @@ -20,19 +20,23 @@ These make us iterate fast before stabilizing it for the current release. ### Release steps -The prototype name must follow this convention: `prototype-v.-` where +The prototype name must [follow this convention](https://semver.org/#spec-item-11): `prototype-v-.` where - `version` is the version of Meilisearch on which the prototype is based. -- `name` is the feature name formatted in `kebab-case`. It should not end with a single number. -- `Y` is the version of the prototype, starting from `0`. +- `name` is the feature name formatted in `kebab-case`. +- `number` is the iteration of the prototype, starting from `0`. -✅ Example: `prototype-v1.23.0.search-personalization-0`.
+✅ Example: `prototype-v1.23.0-search-personalization.1`.
+❌ Bad example: `prototype-v1.23.0-search-personalization-0`: a dash separates the name and version.
+❌ Bad example: `prototype-v1.23.0.search-personalization.0`: a dot separates the version and name.
❌ Bad example: `prototype-search-personalization-0`: version is missing.
-❌ Bad example: `v1.23.0.auto-resize-0`: lacks the `prototype` prefix.
-❌ Bad example: `prototype-v1.23.0.auto-resize`: lacks the version suffix.
-❌ Bad example: `prototype-v1.23.0.auto-resize-0-0`: feature name ends with a single number. +❌ Bad example: `v1.23.0-auto-resize-0`: lacks the `prototype` prefix.
+❌ Bad example: `prototype-v1.23.0-auto-resize`: lacks the version suffix.
+❌ Bad example: `prototype-v1.23.0-auto-resize.0-0`: feature name ends with two numbers. Steps to create a prototype: + + 1. In your terminal, go to the last commit of your branch (the one you want to provide as a prototype). 2. Create a tag following the convention: `git tag prototype-X-Y` 3. Run Meilisearch and check that its launch summary features a line: `Prototype: prototype-X-Y` (you may need to switch branches and back after tagging for this to work).