Adding new joomla development strategy

rdeutz commented 2 months ago

User description

This is the updated Joomla Development Strategy, voted on by the Production Department.

PR Type

documentation

Description

Added a new development strategy document for Joomla, outlining the approach and management of changes within the project.
Detailed the version numbering scheme, release cycle, and backward compatibility policy.
Included policies on contributions, security, software upgrades, and deprecation.
Provided guidelines on the minimum technical requirements and handling of regressions.

Changes walkthrough 📝

Relevant files

Documentation

index.md

Added Joomla Development Strategy Document

docs/development-strategy/index.md

Added a comprehensive development strategy document for Joomla.

Included sections on version numbering, release cycle, and backward
compatibility.

Detailed policies on contributions, security, and software upgrades.

Provided guidelines on deprecation and minimum technical requirements.

+310/-0

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

codiumai-pr-agent-pro[bot] commented 2 months ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

codiumai-pr-agent-pro[bot] commented 2 months ago

PR Code Suggestions ✨

Category	Suggestion	Score
Usability	Add a clickable table of contents for better document navigation ___ To improve navigation and user experience, consider adding a clickable table of contents at the beginning of the document. This will allow users to jump directly to sections of interest. [docs/development-strategy/index.md [5-11]](https://github.com/joomla/Manual/pull/295/files#diff-9a04b123019ef4bb47c228433035901288bad874004d4f361732f004e5aedb61R5-R11) ```diff Joomla\! Development Strategy ============= +## Table of Contents +- [Introduction](#introduction) +- [Executive Summary](#executive-summary) +- [Mission](#mission) +- [Goals](#goals) +- [Principles](#principles) +- [Contribution Policy](#contribution-policy) +- [Software Release Cycle](#software-release-cycle) +- [Backward Compatibility Policy](#backward-compatibility-policy) +- [Security Policy](#security-policy) +... ## Introduction ... ``` Suggestion importance[1-10]: 10 Why: Adding a clickable table of contents greatly improves navigation and user experience, allowing users to jump directly to sections of interest. This is a highly beneficial usability enhancement.	10
Enhancement	Add a glossary section to define technical terms and acronyms ___ Consider adding a glossary section at the end of the document to define technical terms and acronyms used throughout the document. This will help new users understand the content more easily. [docs/development-strategy/index.md [5-11]](https://github.com/joomla/Manual/pull/295/files#diff-9a04b123019ef4bb47c228433035901288bad874004d4f361732f004e5aedb61R5-R11) ```diff Joomla\! Development Strategy ============= ## Introduction ... +## Glossary +- CMS: Content Management System +- JSST: Joomla Security Strike Team +- RFC: Request for Comments +- SemVer: Semantic Versioning ``` Suggestion importance[1-10]: 9 Why: Adding a glossary section is a significant enhancement that will help new users understand the content more easily, improving the overall accessibility of the document.	9
Enhancement	Break down the document into multiple linked sections for better readability ___ Consider breaking down the long document into multiple linked documents for better readability and navigation. This can help users find specific information faster and make the document less overwhelming. [docs/development-strategy/index.md [5-11]](https://github.com/joomla/Manual/pull/295/files#diff-9a04b123019ef4bb47c228433035901288bad874004d4f361732f004e5aedb61R5-R11) ```diff Joomla\! Development Strategy ============= ## Introduction ... +[Read more about our detailed strategies in the dedicated sections.](#detailed-strategies) ``` Suggestion importance[1-10]: 7 Why: Breaking down the document into multiple linked sections can improve readability and navigation, making it easier for users to find specific information. However, the suggestion is somewhat general and does not provide a detailed implementation plan.	7
Maintainability	Use a table format for clearer presentation of version numbering ___ To enhance clarity and maintainability, consider using a table format for the version numbering explanation instead of bullet points. This will make the information more structured and easier to understand at a glance. [docs/development-strategy/index.md [28]](https://github.com/joomla/Manual/pull/295/files#diff-9a04b123019ef4bb47c228433035901288bad874004d4f361732f004e5aedb61R28-R28) ```diff -* The version numbering scheme is your key to understanding the degree of change inherent in a release. 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. +\| Version Part \| Description \| Example \| +\|--------------\|-------------\|---------\| +\| Major \| Indicates a major release with potential backward compatibility breaks. \| 5 (in 5.3.2) \| +\| Minor \| Indicates a minor release with new features, backward compatible. \| 3 (in 5.3.2) \| +\| Patch \| Indicates bug fixes and security updates, backward compatible. \| 2 (in 5.3.2) \| +Refer to our Release Policy for further details. ``` - [ ] Apply this suggestion Suggestion importance[1-10]: 8 Why: Using a table format for the version numbering explanation enhances clarity and maintainability, making the information more structured and easier to understand at a glance. This is a practical improvement for readability.	8

joomla / Manual