diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1b8b296ebfb4d..4df560490fdea 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,28 +1,46 @@ Contributing to the Joomla! CMS™ -=============== -You are welcome to submit a contribution for review and possible inclusion in the Joomla! CMS but, before it will be accepted, we ask that you follow these simple guidelines: +================================ -* If you have a feature request, then please open a discussion to define the feature request and discuss possible solutions. Discussions can be converted into issues when the request is defined sufficiently that a developer can start coding the feature. In this process you will get feedback from the maintainers, if the feature is something for the Joomla core distribution or not. +You are welcome to submit a contribution for review and possible inclusion in the Joomla! CMS but, +before it will be accepted, we ask that you follow these simple guidelines: -* If you have found a bug, open an issue on our [Issue Tracker](https://issues.joomla.org/) or here on GitHub. If you can, please provide a fix and create a pull request (PR) instead; this will automatically create an issue for you so you do not have to create an issue, if you are creating a pull request. +* If you have a feature request, then please open a discussion to define the feature request and discuss possible solutions. + Discussions can be converted into issues when the request is defined sufficiently that a developer can start coding the feature. + In this process you will get feedback from the maintainers, if the feature is something for the Joomla core distribution or not. + +* If you have found a bug, open an issue on our [Issue Tracker](https://issues.joomla.org/) or here on GitHub. + If you can, please provide a fix and create a pull request (PR) instead; this will automatically create an issue + for you so you do not have to create an issue, if you are creating a pull request. * Follow the [Joomla! Coding Standards](https://manual.joomla.org/docs/get-started/codestyle) for code contributions. -* When filing an issue or opening a Pull Request(PR), please include a clear title and description. The title should be a short summary of the issue. For example, `Invalid Query in com_admin`. All issues and PRs should include a description with as much detail as possible. If it is a PR, include what the issue is, what the PR is addressing, testing instructions and environmental information (PHP version, database driver and version, and other data you can retrieve from your site's system information view) in case the issue is specific to certain environments. If additional information is needed, please be prepared to provide it as our community members review your submission. +* When filing an issue or opening a Pull Request(PR), please include a clear title and description. + The title should be a short summary of the issue. For example, `Invalid Query in com_admin`. All issues and PRs + should include a description with as much detail as possible. If it is a PR, include what the issue is, what the + PR is addressing, testing instructions and environmental information (PHP version, database driver and version, + and other data you can retrieve from your site's system information view) in case the issue is specific to certain + environments. If additional information is needed, please be prepared to provide it as our community members + review your submission. -* Report security issues to the Joomla! Security Strike Team (JSST) at security@joomla.org or use the [JSST contact form](https://developer.joomla.org/contact-security-team.html). Please do not use the public tracker for security issues. Find [here](https://github.com/joomla/joomla-cms?tab=security-ov-file#readme) more information about the [Security Policies and Procedures](https://github.com/joomla/joomla-cms?tab=security-ov-file#readme). +* Report security issues to the Joomla! Security Strike Team (JSST) at security@joomla.org or use + the [JSST contact form](https://developer.joomla.org/contact-security-team.html). Please do not use the public tracker + for security issues. Find [here](https://github.com/joomla/joomla-cms?tab=security-ov-file#readme) more information + about the [Security Policies and Procedures](https://github.com/joomla/joomla-cms?tab=security-ov-file#readme). * Please follow our [Generative AI policy](https://developer.joomla.org/generative-ai-policy.html) when using AI to contribute to the Joomla! project Please be patient as not all items will be viewed or tested immediately (remember, all bug testing for the Joomla! CMS is done by volunteers) and be receptive to feedback about your code. #### Branches -Bug fixing PRs should be made to the `5.4-dev` branch. Merged bugfixes will be upmerged into the current branches. New features that do not break backwards compatibility should be made to the `6.2-dev`. +Joomla 5.4 is in security maintenance mode until 12th October 2027, which means it will only receive security fixes. +Bug fixing PRs should be made to the `6.2-dev` branch. Merged bugfixes will be upmerged into the current branches. +New features that do not break backwards compatibility should be made to the `6.3-dev` branch, otherwise they should +be made to the `7.0-dev` branch. | Branch | Purpose | |---------|--------------------------------------------------------------------------------------------------------------| -| 5.4-dev | Branch for the current 5.x Joomla version. | -| 6.1-dev | Branch for the current 6.x Joomla version. Bugfixes only for 6.1 go into this branch. | -| 6.2-dev | Branch for the next minor 6.x Joomla version. New features have to go into this branch. | +| 5.4-dev | Branch for the current 5.x Joomla version. Currently in security maintenance mode. | +| 6.2-dev | Branch for the current 6.x Joomla version. Bugfixes go into this branch. | +| 6.3-dev | Branch for the next minor 6.x Joomla version. New features have to go into this branch. | | 7.0-dev | Branch for the next major Joomla version. New features that include a b/c break have to go into this branch. | diff --git a/README.md b/README.md index 1deecedd6be93..c053c16850281 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,37 @@ Joomla! CMS™ -==================== +============ -Build Status ------------- +## Build Status | Actions | PHP | Node | npm | |-------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| | [![Build Status](https://github.com/joomla/joomla-cms/actions/workflows/ci.yml/badge.svg?branch=5.4-dev)](https://github.com/joomla/joomla-cms) | [![PHP](https://img.shields.io/badge/PHP-V8.1.0-green)](https://www.php.net/) | [![node-lts](https://img.shields.io/badge/Node-V20.0-green)](https://nodejs.org/en/) | [![npm](https://img.shields.io/badge/npm-v10.1.0-green)](https://nodejs.org/en/) | -Overview ---------------------- +## Overview + * This is the source of Joomla! 5.x. * Joomla's [Official website](https://www.joomla.org). * Joomla! 5.4 [version history](https://docs.joomla.org/Special:MyLanguage/Joomla_5.4_version_history). * Detailed changes are in the [changelog](https://github.com/joomla/joomla-cms/commits/5.4-dev). +* Release Managers responsible for Joomla! 5.4 + * Heiko Lübbe @muhme + * Richard Fath @richard67 + +## What is Joomla? -What is Joomla? ---------------------- * [Joomla!](https://www.joomla.org/about-joomla.html) is a **Content Management System** (CMS) which enables you to build websites and powerful online applications. * It is a simple and powerful web server application which requires a server with PHP and either MySQL, MariaDB or PostgreSQL to run. You can find [full technical requirements here](https://downloads.joomla.org/technical-requirements). * Joomla! is **free and Open Source software** distributed under the GNU General Public License version 2 or later. -Looking for an installable package? ---------------------- +## Looking for an installable package? + Joomla is not installable out of the box from this repository, please use: - For the latest stable package: https://downloads.joomla.org - For a nightly package: https://developer.joomla.org/nightly-builds.html -How to get a working installation from the source ---------------------- -For detailed instructions please visit https://docs.joomla.org/Special:MyLanguage/J5.x:Setting_Up_Your_Local_Environment +## How to get a working installation from the source + +For detailed instructions please visit https://guide.joomla.org/user-manual/hosting/local-environment-setup You will need: - PHP - basically the same as you need for running a Joomla Site, but you need the cli (command line interface) Version (see https://docs.joomla.org/Special:MyLanguage/Configuring_a_LAMPP_server_for_PHP_development) @@ -64,8 +66,8 @@ Joomla creates a cache of the namespaces of its extensions in `JOOMLA_ROOT/admin extensions are created, deleted or removed in git then this file needs to be recreated. You can simply delete the file and it will be regenerated on the next call to Joomla. -Do you want to improve Joomla? --------------------- +## Do you want to improve Joomla? + * Where to [request a feature](https://issues.joomla.org)? * How do you [report a bug](https://docs.joomla.org/Special:MyLanguage/Filing_bugs_and_issues) on the [Issue Tracker](https://issues.joomla.org)? * How to [submit code](https://manual.joomla.org/docs/get-started/git/) to the Joomla CMS using a Pull Request? @@ -74,22 +76,21 @@ Do you want to improve Joomla? * Documentation for [Web designers](https://docs.joomla.org/Special:MyLanguage/Web_designers). * Provide a translation for Joomla: [Joomla Crowdin Project](https://joomla.crowdin.com/cms) -Which branch should my Pull Request target? --------------------- +## Which branch should my Pull Request target? + Using a simple classification keeps the project **stable**, **transparent**, and **easy** for everyone to contribute. -| Type of change | What it means | Target branch | -|---|---|---| -| **Bug / Patch release** | The change fixes an actual error. The software crashes, produces the wrong result, or behaves contrary to its specification. It can be resolved without large‑scale refactoring or new functionality. | **[5.4-dev](https://github.com/joomla/joomla-cms/tree/5.4-dev)** (6.1-dev) **\*** | -| **Feature / Minor release** | Anything that isn’t a strict bug – new behavior, refactoring, performance improvements, enhancements, UI tweaks, etc. These changes are bundled together for the next minor version. | **[6.2-dev](https://github.com/joomla/joomla-cms/tree/6.2-dev)** | +| Type of change | What it means | Target branch | +|---|---|-------------------------------------------------------------------------------------------------------------------------------------| +| **Bug / Patch release** | The change fixes an actual error. The software crashes, produces the wrong result, or behaves contrary to its specification. It can be resolved without large‑scale refactoring or new functionality. | **[6.2-dev](https://github.com/joomla/joomla-cms/tree/6.2-dev)** **\*** | +| **Feature / Minor release** | Anything that isn’t a strict bug – new behavior, refactoring, performance improvements, enhancements, UI tweaks, etc. These changes are bundled together for the next minor version. | **[6.3-dev](https://github.com/joomla/joomla-cms/tree/6.3-dev)** | -**\*** All bugs that already exist in version 5.4.x should be fixed in `5.4-dev`. Only bugs that are introduced for the first time in version 6.x should target the [`6.1-dev`](https://github.com/joomla/joomla-cms/tree/6.1-dev) branch. +**\*** All bugs that already exist in version 5.4.x or 6.1.x or 6.2.x should be fixed in `6.2-dev`. A member of the maintainer or bug squad team confirms the classification and sets the appropriate labels when a PR is opened. If a PR is opened in the wrong branch, a maintainer will simply ask you to retarget it to the proper branch. +## Copyright -Copyright ---------------------- * (C) 2005 Open Source Matters, Inc. * Distributed under the GNU General Public License version 2 or later * See [License details](https://docs.joomla.org/Special:MyLanguage/Joomla_Licenses) diff --git a/README.txt b/README.txt index 44c59b0fc8fae..b587d6b71db99 100644 --- a/README.txt +++ b/README.txt @@ -5,6 +5,9 @@ Joomla! CMS™ * Joomla! Official site: https://www.joomla.org * Joomla! 5.4 version history - https://docs.joomla.org/Special:MyLanguage/Joomla_5.4_version_history * Detailed changes in the Changelog: https://github.com/joomla/joomla-cms/commits/5.4-dev + * Release Managers responsible for Joomla! 5.4 + * Heiko Lübbe @muhme + * Richard Fath @richard67 2- What is Joomla? * Joomla! is a Content Management System (CMS) which enables you to build websites and powerful online applications. @@ -48,6 +51,7 @@ Joomla! CMS™ 10- Where can you get support and help? * The Joomla! Documentation: https://docs.joomla.org/Special:MyLanguage/Main_Page + * Developer Documentation: https://manual.joomla.org/docs/ * FAQ Frequently Asked Questions: https://docs.joomla.org/Special:MyLanguage/Category:FAQ * Find the information you need: https://docs.joomla.org/Special:MyLanguage/Start_here * Find help and other users: https://www.joomla.org/about-joomla/create-and-share.html