|
1 | 1 | Contributing to the Joomla! CMS™ |
2 | | -=============== |
3 | | -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: |
| 2 | +================================ |
4 | 3 |
|
5 | | -* 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. |
| 4 | +You are welcome to submit a contribution for review and possible inclusion in the Joomla! CMS but, |
| 5 | +before it will be accepted, we ask that you follow these simple guidelines: |
6 | 6 |
|
7 | | -* 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. |
| 7 | +* If you have a feature request, then please open a discussion to define the feature request and discuss possible solutions. |
| 8 | + Discussions can be converted into issues when the request is defined sufficiently that a developer can start coding the feature. |
| 9 | + In this process you will get feedback from the maintainers, if the feature is something for the Joomla core distribution or not. |
| 10 | + |
| 11 | +* If you have found a bug, open an issue on our [Issue Tracker](https://issues.joomla.org/) or here on GitHub. |
| 12 | + If you can, please provide a fix and create a pull request (PR) instead; this will automatically create an issue |
| 13 | + for you so you do not have to create an issue, if you are creating a pull request. |
8 | 14 |
|
9 | 15 | * Follow the [Joomla! Coding Standards](https://manual.joomla.org/docs/get-started/codestyle) for code contributions. |
10 | 16 |
|
11 | | -* 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. |
| 17 | +* When filing an issue or opening a Pull Request(PR), please include a clear title and description. |
| 18 | + The title should be a short summary of the issue. For example, `Invalid Query in com_admin`. All issues and PRs |
| 19 | + should include a description with as much detail as possible. If it is a PR, include what the issue is, what the |
| 20 | + PR is addressing, testing instructions and environmental information (PHP version, database driver and version, |
| 21 | + and other data you can retrieve from your site's system information view) in case the issue is specific to certain |
| 22 | + environments. If additional information is needed, please be prepared to provide it as our community members |
| 23 | + review your submission. |
12 | 24 |
|
13 | | -* Report security issues to the Joomla! Security Strike Team (JSST) at [email protected] 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). |
| 25 | +* Report security issues to the Joomla! Security Strike Team (JSST) at [email protected] or use |
| 26 | + the [JSST contact form](https://developer.joomla.org/contact-security-team.html). Please do not use the public tracker |
| 27 | + for security issues. Find [here](https://github.com/joomla/joomla-cms?tab=security-ov-file#readme) more information |
| 28 | + about the [Security Policies and Procedures](https://github.com/joomla/joomla-cms?tab=security-ov-file#readme). |
14 | 29 |
|
15 | | -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. |
| 30 | +Please be patient as not all items will be viewed or tested immediately (remember, all bug testing for the Joomla! CMS |
| 31 | +is done by volunteers) and be receptive to feedback about your code. |
16 | 32 |
|
17 | 33 | #### Branches |
18 | 34 | 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.1-dev`. |
19 | 35 |
|
20 | | - |
21 | 36 | | Branch | Purpose | |
22 | 37 | |---------|-----------------------------------------------------------------------------------------| |
23 | 38 | | 5.4-dev | Branch for the current 5.x Joomla version. | |
24 | 39 | | 6.0-dev | Branch for the current 6.x Joomla version. Bugfixes only for 6.x go into this branch. | |
25 | 40 | | 6.1-dev | Branch for the next minor 6.x Joomla version. New features have to go into this branch. | |
| 41 | +| 7.0-dev | Branch for the next major Joomla version. New features that include a b/c break have to go into this branch. | |
0 commit comments