Versioning Guidelines

Semantic Versioning (SemVer)

This GitHub wiki follows Semantic Versioning (SemVer) principles to ensure clear and predictable versioning for our documentation. SemVer consists of three numbers separated by dots: MAJOR.MINOR.PATCH.

1. MAJOR: Increment when there are significant and incompatible changes to the content. This could include major restructuring, renaming of key topics, or changes that require users to update their workflows.

2. MINOR: Increment when new content or features are added in a backward-compatible manner. This could include the addition of new articles, examples, or improvements to existing documentation.

3. PATCH: Increment for backward-compatible fixes or minor updates. This includes correcting typos, clarifying text, or making small improvements to the documentation.

Release Process

1. Create a Release: When it's time to release a new version of the documentation, create a new GitHub release. Use the MAJOR, MINOR, or PATCH version increment based on the changes made.

2. Tag the Release: Tag the release with the version number (e.g., v1.0.0) to make it easy to reference.

3. Release Notes: Include clear and concise release notes in the GitHub release. Mention the changes made at each version level (MAJOR, MINOR, PATCH) to provide transparency to users.

4. Documentation Updates: Update the documentation to reflect the changes made in the release. Ensure that any new content or features are properly documented.

5. Backward Compatibility: Ensure that changes made in the MINOR and PATCH releases are backward compatible to minimize disruption for users.

Example

• If you make significant changes or restructure the documentation, increment the MAJOR version (e.g., v2.0.0).

• If you add new articles or improve existing documentation in a backward-compatible way, increment the MINOR version (e.g., v1.1.0).

• If you correct typos or make minor clarifications, increment the PATCH version (e.g., v1.0.1).

Commit Messages

When making changes to the documentation, use clear and descriptive commit messages. Reference the issue or pull request number if applicable.

Example commit message:

feat: Add new section on advanced usage (#123)

By following these versioning guidelines and SemVer principles, we aim to provide our users with a transparent and reliable documentation update process.