29
0
mirror of https://github.com/joomla/joomla-cms.git synced 2024-06-06 20:31:31 +00:00
cms/.github/CONTRIBUTING.md
Robert Deutz 9dd4c952c0
update content for Contributing.md (#43478)
* update content

* Update .github/CONTRIBUTING.md

Co-authored-by: Brian Teeman <brian@teeman.net>

* Update .github/CONTRIBUTING.md

Co-authored-by: Brian Teeman <brian@teeman.net>

* Update .github/CONTRIBUTING.md

Co-authored-by: Brian Teeman <brian@teeman.net>

---------

Co-authored-by: Brian Teeman <brian@teeman.net>
2024-05-15 19:36:14 +02:00

2.8 KiB

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 steps:

  1. Open an issue on our Issue Tracker 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.

  2. Follow the Joomla! Coding Standards.

  3. When filing an issue or opening a PR, please include a clear title and description. The title should be a short summary of an issue and, if possible, should include a reference to an open issue. For example, Invalid Query in com_admin (Ref #1234) would be sufficient. 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.

  4. Report security issues to the Joomla! Security Strike Team (JSST) at security@joomla.org or use the JSST contact form. Please do not use the public tracker for security issues.

  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.

Please be patient as not all items will be tested immediately (remember, all bug testing for the Joomla! CMS is done by volunteers) and be receptive to feedback about your code.

Branches

While 4.4 is in maintenance mode, ie we are still fixing bugs, PRs should be made to the 4.4-dev branch. Merged bugfixes will be upmerged into the current 5.x branch. If a bug is only in the 5.x series the PR should be made to the current 5.x branch (currently 5.1).

Branch Purpose
4.4-dev Branch for the current 4.x Joomla version. Currently in maintenance mode
5.1-dev Branch for the current 5.x Joomla version. Bugfix only for 5.x go into this branch.
5.2-dev Branch for the next minor 5.x Joomla version. New features go into this branch.
6.0-dev Branch for the next major Joomla version. New features that include a b/c break have to go into this branch.