Contributions and patches are essential for the success of our open source projects. We simply can’t access the huge number of platforms and myriad configurations for running our code. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing our open source projects. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Core vs Extensions
All our open source projects are extensible. New functionality is typically directed toward extensions to provide a slimmer Core, reducing its surface area, and to allow greater freedom for extension maintainers to ship releases at their own cadence, rather than being held to the cadence of Core releases. All our projects are build to be packageble and extensible using Composer.
If you are unsure of whether your contribution should be implemented as an extension or part of the Core, you may visit joomlatools/dev on Gitter or ask on the Joomlatools dev mailing list for advice.
Using the issue tracker
- Please do not use the issue tracker for personal support requests (use the Joomlatools mailing list).
- Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.
A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
- Use the GitHub issue search — check if the issue has already been reported.
- Check if the issue has been fixed — try to reproduce it using the latest
masteror development branch in the repository.
- Isolate the problem — make sure that the code in the repository is definitely responsible for the issue.
A good bug report shouldn’t leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.
We use the issue tracker to keep track of planned features. A planned feature is a feature we have discussed and approved to be implemented.
If you want to make a new feature request please keep in mind that the issue tracker is not the place to do so. We are most happy to
discuss your ideas in our Gitter chat at any time!
Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the developers might not want to merge into the project.
Please adhere to the coding conventions used throughout the project (indentation, comments, etc.).
Adhering to the following this process is the best way to get your work merged:
Fork our repository and clone your fork:
git clone https://github.com/<your-username>/<repository-name>
Assign the original repository to a remote called
git remote add upstream https://github.com/<upsteam-owner>/<repository-name>
If you cloned a while ago, get the latest changes from
git checkout <dev-branch> git pull upstream <dev-branch>
Create a new topic branch (off the main project development branch) to contain your feature, change or fix:
git checkout -b <topic-branch-name>
Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git’s interactive rebase feature to tidy up your commits before making them public.
Locally merge (or rebase) the upstream development branch into your topic branch:
git pull [--rebase] upstream <dev-branch>
Push your topic branch up to your fork:
git push origin <topic-branch-name>
Open a Pull Request with a clear title and description.
As a contributor, you retain the copyright to your code, however by contributing code to one of our Joomlatools code repositories you are releasing your code under the same license terms as specified in the LICENSE.txt file included in each repository. In most cases this will be the GPLv3 or MPLv2 licenses.