forked from joomla/Component-Builder
18 lines
1.5 KiB
Markdown
18 lines
1.5 KiB
Markdown
Contributing to the Joomla Component Builder (JCB)
|
|
===============
|
|
If you wish to submit a contribution for review and potential inclusion in the Joomla Component Builder (JCB), please follow these simple steps:
|
|
|
|
1) Open an issue on GitHub, and if possible, provide a fix and create a pull request (PR). Creating a PR automatically generates an issue so that you do not need to create one separately.
|
|
|
|
2) Adhere to the [Joomla! Coding Standards](https://developer.joomla.org/coding-standards.html).
|
|
|
|
3) When filing an issue or opening a PR, provide a clear and concise title and description. The title should include a brief summary of the issue and reference to an open issue if possible. For example, Invalid Query in com_admin (Ref #1234) is sufficient. Additionally, provide a detailed description of the issue or PR, including what the problem is, what the PR is addressing, testing instructions, and environmental information such as PHP version and database driver and version, in case the issue is specific to certain environments.
|
|
|
|
4) Report security issues to the JCB! Core Team using the [Report security issues contact form](https://www.vdm.io/report-security-issues) instead of using public forums.
|
|
|
|
Please be patient, as not all items will be immediately tested since all bug testing for the JCB is performed by volunteers. Additionally, be open to feedback regarding your code.
|
|
|
|
#### Branches
|
|
For PRs, submit to the staging branch as it contains the most up-to-date version of the code.
|
|
|