Announcement: Change in Versioning Strategy

[boomzero]

Announcement: Change in Versioning Strategy

Dear XMOJ Script Users and Contributors,

We are excited to share an important update regarding our versioning strategy for the XMOJ Script project. As you know, our current versioning format follows the x.y.z convention, where x represents major versions, y represents minor versions, and z represents patch versions. Currently, we are at version 1.2.75.

Reason for Change

We have observed that the z component, which is intended to signify patch numbers, has grown significantly large. This can lead to confusion and difficulty in tracking versions, especially when patch numbers are supposed to denote smaller, more frequent updates and fixes.

New Versioning Strategy

To address this issue and improve the clarity of our versioning, we are implementing the following changes to our strategy:

1. Stable Releases:

   • For all stable releases, we will now increment the y (minor) number instead of the z (patch) number.
   • This means that any new features, improvements, or non-breaking changes will result in an increment of the minor version number.
   • Example: If the current version is 1.2.75, the next stable release will be 1.3.0.

2. Pre-releases:

   • For pre-releases (pull requests to dev), we will continue to increment the z (patch) number.
   • This allows us to maintain the frequency of updates and fixes during the testing and evaluation phases without impacting the stable versioning.
   • Example: If the current pre-release version is 1.2.75, the next pre-release will be 1.2.76.

3. Major Releases:

   • The x (major) number will be incremented only when there are significant changes that introduce incompatibilities or major overhauls to the system.
   • This ensures that major version increments are reserved for substantial updates that may require users to adapt to new changes.
   • Example: If the current version is 1.3.0 and a major change is introduced, the next version will be 2.0.0.

Benefits of the New Strategy

• Clarity: The new strategy will provide clearer distinctions between different types of updates, making it easier for users to understand the scope and impact of each release.
• Manageability: By incrementing the minor version for stable releases, we can avoid excessively large patch numbers and maintain a more organized versioning system.
• Consistency: This approach aligns with widely accepted versioning practices, making it easier for contributors and users to follow and predict version changes.

Transition Plan

We will start implementing this new versioning strategy immediately. Our next stable release will reflect these changes, and we will ensure that all future versions adhere to the updated strategy.

Feedback and Support

We value your feedback and are here to support you during this transition. If you have any questions, concerns, or suggestions regarding the new versioning strategy, please feel free to reach out to us through our GitHub repository's discussion forums or issue tracker.

Thank you for your continued support and contributions to the XMOJ Script project. We look forward to delivering even more improvements and features in a clear and organized manner.

Best regards,

The XMOJ Script Development Team

[boomzero]

Refer to 17c711b

[boomzero]

@PythonSmall-Q