Skip to content

Semantic versioning mentioned #501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

mozaffar
Copy link

@mozaffar mozaffar commented Aug 15, 2025

User description

Added: A description added to show that Joomla is using semantic versioning. These links helps the documentation become more visible in SERP too. This is mentioned in next page in https://manual.joomla.org/docs/development-strategy/software-release-cycle/#release-phase


PR Type

Documentation


Description

  • Added reference to Semantic Versioning specification

  • Enhanced version numbering explanation with external link


Diagram Walkthrough

flowchart LR
  A["Version numbering explanation"] --> B["Added Semantic Versioning link"] --> C["Enhanced documentation clarity"]
Loading

File Walkthrough

Relevant files
Documentation
index.md
Added Semantic Versioning reference to documentation         

versioned_docs/version-5.3/development-strategy/index.md

  • Added reference to Semantic Versioning specification with external
    link
  • Enhanced the version numbering explanation section
  • Improved documentation clarity and SEO visibility
+2/-1     

Added: A description added to show that Joomla is using semantic versioning. These links helps the documentation become more visible in SERP too.
This is mentioned in next page in https://manual.joomla.org/docs/development-strategy/software-release-cycle/#release-phase
Copy link
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Formatting

The new bullet splits the sentence across two lines, breaking the list item’s flow. Consider keeping the entire sentence on one line or using an explicit line break that preserves Markdown rendering.

* The version numbering scheme is your key to understanding the degree of change inherent in a release. Joomla! uses [Semantic Versioning](https://semver.org/)
 method. In summary, the version number is in three parts separated by dots: \[major\].\[minor\].\[patch\]. For example, 5.3.2 has a major number of 5, a minor number of 3 and a patch number of 2\. A release which increments the major number is referred to as a major release; one that increments only the minor number is a minor release; and one that increments only the patch number is a patch release. Refer to our Release Policy for further details.
Link punctuation

The link to Semantic Versioning lacks terminal punctuation and reads awkwardly before “method.” Consider “...uses Semantic Versioning method” or better “...follows Semantic Versioning” and then continue the sentence smoothly.

* The version numbering scheme is your key to understanding the degree of change inherent in a release. Joomla! uses [Semantic Versioning](https://semver.org/)
 method. In summary, the version number is in three parts separated by dots: \[major\].\[minor\].\[patch\]. For example, 5.3.2 has a major number of 5, a minor number of 3 and a patch number of 2\. A release which increments the major number is referred to as a major release; one that increments only the minor number is a minor release; and one that increments only the patch number is a patch release. Refer to our Release Policy for further details.
Internal references

“Release Policy,” “Backward Compatibility Policy,” and “Support Policy” are referenced but not linked in the new bullet. Ensure consistent internal linking for better navigation and SEO.

 method. In summary, the version number is in three parts separated by dots: \[major\].\[minor\].\[patch\]. For example, 5.3.2 has a major number of 5, a minor number of 3 and a patch number of 2\. A release which increments the major number is referred to as a major release; one that increments only the minor number is a minor release; and one that increments only the patch number is a patch release. Refer to our Release Policy for further details.
* A release is said to be "backward compatible" with an earlier release if your system continues to work correctly when updated to that release even when other parts of your system were not updated at the same time. However, there are limits to what is covered by backward compatibility and you should read the Backward Compatibility Policy for the full details.

Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Remove unintended line break

Fix the unintended line break after the link to avoid breaking the list item's
flow and rendering. Keep the sentence on a single line so the bullet renders
correctly and reads smoothly.

versioned_docs/version-5.3/development-strategy/index.md [29-30]

-* The version numbering scheme is your key to understanding the degree of change inherent in a release. Joomla! uses [Semantic Versioning](https://semver.org/)
- method. In summary, the version number is in three parts separated by dots: \[major\].\[minor\].\[patch\]. For example, 5.3.2 has a major number of 5, a minor number of 3 and a patch number of 2\. A release which increments the major number is referred to as a major release; one that increments only the minor number is a minor release; and one that increments only the patch number is a patch release. Refer to our Release Policy for further details.
+* The version numbering scheme is your key to understanding the degree of change inherent in a release. Joomla! uses [Semantic Versioning](https://semver.org/) method. In summary, the version number is in three parts separated by dots: \[major\].\[minor\].\[patch\]. For example, 5.3.2 has a major number of 5, a minor number of 3 and a patch number of 2\. A release which increments the major number is referred to as a major release; one that increments only the minor number is a minor release; and one that increments only the patch number is a patch release. Refer to our Release Policy for further details.
  • Apply / Chat
Suggestion importance[1-10]: 4

__

Why: The suggestion correctly identifies an unnecessary line break within a list item, and removing it improves the markdown source's readability and ensures consistent rendering.

Low
  • More

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant