FancyInnovations/FancyPlugins
1
0
Fork 0
mirror of https://github.com/FancyInnovations/FancyPlugins.git synced 2025-12-06 07:43:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update versioning guidelines

Browse Source
This commit is contained in:
Oliver
2025-03-21 10:44:30 +01:00
parent c5c7d05999
commit 597b4de4f3
1 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/src/development-guidelines/versioning.md
View File

@@ -3,16 +3,21 @@ order: 9
--- ---
# Versioning # Versioning
We use [Semantic Versioning](https://semver.org/) (Semver) for versioning.
The version is structured as follows: `major.minor.patch.<build id>`. The build id is optional and is only used for The version is structured as follows: `major.minor.patch.<build id>`. The build id is optional and is only used for
development builds. development builds.
!!! warning
This versioning system is not getting used yet. We will start applying the rules in the version 3.0.0 of all plugins.
!!!
## Semver ## Semver
### Major ### Major
The major version is increased when there are very significant changes to the codebase. This could be a complete rewrite The major version is increased when there are very significant changes to the codebase. This can be breaking changes to the API and/or major changes to the behavior of the plugin.
of the codebase or a major change in the way the plugin works. This is usually not done very often. When the major When the major version is increased, the minor and patch versions are reset to 0.
version is increased, the minor and patch versions are reset to 0.
Data might be lost when updating to a new major version. Data might be lost when updating to a new major version.
@@ -26,7 +31,7 @@ minor version is increased, the patch version is reset to 0.
Data will not be lost when updating to a new minor version. Data will not be lost when updating to a new minor version.
Breaking changes in the API are expected when updating to a new minor version. No breaking changes in the API are expected when updating to a new minor version.
### Patch ### Patch
@@ -41,6 +46,9 @@ Breaking changes in the API are not expected when updating to a new patch versio
The build id is optional and is only used for development builds. The build id is increased every time a new build is The build id is optional and is only used for development builds. The build id is increased every time a new build is
created. created.
The build id is not reset when increasing the major, minor or patch version - it is completely independent.
Disclaimers for development builds:
- Development builds are not recommended for production use. - Development builds are not recommended for production use.
- Development builds might contain bugs. - Development builds might contain bugs.
- Development builds might contain incomplete features. - Development builds might contain incomplete features.
@@ -64,6 +72,5 @@ changelog should contain the following information:
- A list of changes that were made in this release - A list of changes that were made in this release
- A list of bug fixes that were made in this release - A list of bug fixes that were made in this release
- A list of new features that were added in this release - A list of new features that were added in this release
- A list of changes to the API that were made in this release
There are mostly changes list that are important to server admins. Breaking changes to the API might not be listed in - A list of breaking changes that were made in this release
the changelog.