Skip to content

Commit e84ae0d

Browse files
Review
1 parent 955e922 commit e84ae0d

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

content/en/docs/refguide/modeling/app-explorer/modules/module-settings.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ When the module is set as the solution module, it gets the letter **S** as an ic
6969
Version is available for all module types for Studio Pro 11.12 and above. In earlier versions of Studio Pro, version is available only for add-on and solution module types.
7070
{{% /alert %}}
7171

72-
This is the version number of the module which will be shown in various places in the Studio Pro user interface, as well as in the Marketplace.
72+
This is the version number of the module which is shown in various places in the Studio Pro user interface, as well as in the Marketplace.
7373

7474
When redistributing a module, you should always change the version number when changes are made. For modules that will be published to the Marketplace, the version must be set before exporting the package.
7575

@@ -78,13 +78,15 @@ The Marketplace automatically uses the version from the exported package. You ca
7878
{{% /alert %}}
7979

8080
#### Version format
81-
The version should be a semantic version, consisting of at least three numerical parts: major, minor, and patch version, such as `1.3.7`.
8281

83-
* Increase the MAJOR version when making breaking changes. Examples are removing functionality like an entity or a microflow, or upgrading the module to a new major version of Studio Pro.
84-
* Increase the MINOR version when adding new features in a backward compatible manner. Examples are adding a microflow or entity that don't interfere with existing behavior.
85-
* Increase the PATCH version when making backward compatible bug fixes. Examples are fixing a styling issue on a page or changing a calculation in a microflow without changing the parameters and output type.
82+
The version should be a semantic version, consisting of at least three numerical parts: major, minor, and patch version, such as *1.3.7*.
83+
Refer to the following guidance when changing the version number:
8684

87-
Aside from the numerical major, minor and patch version, more alphanumerical parts are allowed. This is considered to be an advanced feature, for which we refer you to the documentation of [Semantic Versioning](https://semver.org/). An example advanced version number is `1.3.7-beta.2`.
85+
* Increase the major version when making breaking changes, such as removing a functionality like an entity or a microflow, or upgrading the module to a new major version of Studio Pro.
86+
* Increase the minor version when adding new features in a backward compatible manner. For example, when adding a microflow or entity that do not interfere with existing behavior.
87+
* Increase the patch version when making backward compatible bug fixes, such as fixing a styling issue on a page or changing a calculation in a microflow without changing the parameters and output type.
88+
89+
Next to the numerical major, minor and patch version, alphanumerical characters are allowed. This is considered to be an advanced feature, for more information, please see [Semantic Versioning](https://semver.org/). An example of an advanced version number is *1.3.7-beta.2*.
8890

8991
## Package {#package}
9092

0 commit comments

Comments
 (0)