Mautic is an open source project driven by a large community. If you don't feel ready to contribute code or patches, reviewing issues and pull requests (PRs) can be a great start to get involved and give back. In fact, people who "triage" issues are the backbone to Mautic's success!
Everyone can test submitted features and bug fixes. No programming skills are required. All you have to do is to follow the steps below.
Community reviews are essential for the development of Mautic, since there are many more pull requests and bug reports than there are members in the Mautic core team to review, fix and merge them.
Bug Reports: Bug reports need to be checked for completeness. Is any important information missing? Can the bug be reproduced?
Pull Requests: Pull requests contain code that fixes a bug or implements new functionality. Reviews of pull requests ensure that they are implemented properly, are covered by test cases, don't introduce new bugs and maintain backward compatibility.
Note that anyone who has some basic familiarity with Mautic and PHP can review bug reports and pull requests. You don't need to be an expert to help.
Before you begin, remember that you are looking at the result of someone else's hard work. A good review comment thanks the contributor for their work, identifies what was done well, identifies what should be improved and suggests a next step.
The steps for the review are:
Good bug reports contain enough information and code samples to reproduce the bug. Issue forms do ensure the basic set of information but sometimes this may not be enough to reproduce the issue. Ask for clarification if you are not sure.
Install Mautic locally and test whether the bug can be reproduced on your system. If the reporter did not provide enough information, ask for clarification.
At last, add a comment to the bug report. Thank the reporter for reporting the bug. Here is a sample comment for a bug report that could be reproduced:
Thank you @mautibot for creating this bug report! This indeed looks like a bug. I reproduced the bug in the "kernel-bug" branch of https://github.com/example/some-project.
Every change to Mautic core happens via PRs. Every PR must have a number of successful tests and code review to be merged to the core and released in the next version - the number required depends on the tier of the PR. Testing a PR is a great way to move Mautic forward and personally improve its quality and stability.
rm -rf var/cache/*or
bin/console cache:clear -e dev).
We're planning to provide more thorough guidelines for reviewing bug reports and pull requests in the near future. If you want to contribute in the meantime, please click the "Edit this page on GitHub" link at the bottom of this page.
Found errors? Think you can improve this documentation? edit this page