Contributing to Phalcon
Phalcon is an open source project and a volunteer effort. Phalcon welcomes contribution from everyone. Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
Contributions to Phalcon should be made in the form of GitHub pull requests. Each pull request will be reviewed by a core contributor (someone with permission to merge patches). Feedback can be provided and potentially changes requested or the pull request will be merged. All contributions should follow this format, even those from core contributors.
Questions & Support
We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address all of them. Thus we only accept bug reports, new feature requests and pull requests in GitHub. Our great community and contributors are happy to help you though! Please use these community resources for obtaining help.
Please use the Documentation before anything else. You can also use the search feature in our documents to find what you are looking for. If your question is still not answered, there are more options below.
- Questions should go to Official Forums
- Another way is to ask a question on Stack Overflow and tag it with
- Come join the Phalcon Discord
- Our social network accounts are:
- If you still believe that what you found is a bug, please open an issue
Please report bugs when you've exhausted all of the above options.
Bug Report Checklist
- Make sure you are using the latest released version of Phalcon before submitting a bug report. Bugs in versions older than the latest released one will not be addressed by the core team (so long as the version is not LTS).
- If you have found a bug it is important to add relevant reproducibility information to your issue to allow us to reproduce the bug and fix it quicker. Add a script, small program or repository providing the necessary code to make everyone reproduce the issue reported easily. If a bug cannot be reproduced by the development it would be difficult provide corrections and solutions. Submit Reproducible Test for more information
- Be sure that information such as OS, Phalcon version and PHP version are part of the bug report
- If you're submitting a Segmentation Fault error, we would require a backtrace, please see Generating a Backtrace
Pull Request Checklist
- Don't submit your pull requests to the
masterbranch. Branch from the required branch and, if needed, rebase to the proper branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes
- Don't put submodule updates in your pull request unless they are to landed commits
- Add tests relevant to the fixed bug or new feature. Test classes should follow the PSR-2 coding style guide. See our testing guide for more information
- Phalcon is written in Zephir, please do not submit commits that modify C generated files directly or those whose functionality/fixes are implemented in the C programming language
- Remove any change to
*.zep.hfiles before submitting the pull request