Skip to content

Versions

Kain edited this page Sep 26, 2023 · 2 revisions

Versions are structured as followed: major.minor.rule
If you're contributing to this package please keep this in mind when opening a PR or adding a new rule.

You are not required to bump the version when adding a new rule, if you are confused or unsure just ignore the version and I'll gladly handle it myself when I publish the new changes.
If you are still confused feel free to contact me on Discord: (drkain) or send me an email (see profile).

Major

This refers to a major code change that is unlikely to be compatible with older versions. This changes core functionality and/or how the URLs are cleaned.

Minor

This refers to minor code changes and bug fixes that should not require changes when relied upon as a dependent, this includes support for new handlers or fixing existing handlers that are not working as expected. This should be compatible with older versions, but it's best to double check just to be sure.

Rule

Updating or adding new rules using existing handlers. This means support for a new website or updating an existing rule without changes to the core code. These updates happen fairly often so if you're using tidy-url as a dependency please keep this in mind. These changes will not break core functionality or modify the existing code.

Clone this wiki locally