Skip to content
This repository was archived by the owner on Apr 21, 2026. It is now read-only.

Commit 88a1cb5

Browse files
authored
fix(README): versionPrefix section (#31)
* fix(README): versionPrefix section * requested changes
1 parent 7d3e11c commit 88a1cb5

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,9 +114,9 @@ Default: `""`
114114

115115
[PVP](https://pvp.haskell.org/) is the standard versioning system for Haskell projects which is different from [Semantic Versioning](https://semver.org/). You may think that since this is a `semantic-release` plugin, you'll have to move out from PVP. But thanks to the `versionPrefix` option, you can keep the 4th digit in your version.
116116

117-
This is just an optional feature to enable backward compatibility when starting to use this plugin.
117+
This is an optional feature enabling PVP compatibility when using this plugin. So, if your package uses PVP, `versionPrefix` can save the day, and you can continue using PVP versioning with this amazing tool.
118118

119-
We strongly recommend moving to semantic versioning to keep things simple and follow a well-known standard. But `versionPrefix` can save the day if changing the versioning system is not an option.
119+
Keep in mind that using Semantic Versioning does make things simpler while following another well-known standard.
120120

121121
For example, if you have the version number `0.2.0.7` and want to create a new release for a new feature, semantic-release is going to infer the next version as `2.1.0`, you can keep your previous versioning by adding the following to the plugin configuration:
122122

0 commit comments

Comments
 (0)