Contributing to Phalcon¶
Phalcon is an open-source project and relies heavily on volunteer efforts and contributions. We welcome contributions from everyone!
Please take a few moments to review this document to understand the contribution process and make it as efficient as possible for all. By following these guidelines, we can have faster resolution of issues and better communication, and we can all move the project forward!
If you wish to contribute to Phalcon, you can do so by issuing a GitHub pull request.
When you create a pull request, we have a handy template to help you describe what is the scope of the pull request. It is very important and helpful to the community that you add tests to your pull request. Each pull request will be reviewed by a core contributor (someone with permission to merge pull requests). Based on the type and content of the pull request, it could be:
- merged immediately or
- put on hold, where the reviewer requires changes (styling, tests, etc.)
- put on hold, if a discussion is necessary (community, core team etc.)
If your pull request is a new feature, it is best to discuss it with the core team first, to ensure that it will align with the evolution of the framework.
Please make sure that the target branch that you send your pull request is correct and that you have already rebased your code. Pull requests to the master branch are not allowed
If programming in Zephir seems daunting, there are plenty of areas that you can contribute. You can always check the documentation for any typographic or context errors. You could also enhance the documentation with more examples on the respective pages.
All you have to do is go to our [docs-apps][phalcon-docs-apps] repository, fork it, make the changes, and send us a pull request.
We have removed the translations from v5.5.x onward. There was not that much traffic from the community to help with translating the documentation into different languages.
Questions and Support¶
We only accept bug reports, new feature requests and pull requests in GitHub. For questions regarding the usage of the framework or support requests please visit the official discussions page or our Discord server.
Bug Report Checklist¶
- Make sure you are using the latest released version of Phalcon before creating an issue in GitHub.
- Only bugs found in the latest released version of Phalcon will be addressed.
- We have a handy template when creating an issue to help you provide as much information for the core team to reproduce and address. Being able to reproduce a bug significantly reduces the time to find the cause and fix it. Scripts of even failing tests are more than appreciated. Please check how to create the reproducible tests page for more information.
- As part of your report, please include additional information such as the OS, PHP version, Phalcon version, web server, memory, etc.
- If you're submitting a Segmentation Fault error, we require a backtrace. Please check the Generating a Backtrace section for more information.
Generating a Backtrace¶
Sometimes due to Segmentation Fault error, Phalcon could crash some of your web server processes. In order to help us find the cause of this segmentation fault, we will need the crash backtrace.
Please check the following links for instructions on how to generate the backtrace:
- Generating a gdb backtrace
- Generating a backtrace, with a compiler, on Win32
- Debugging Symbols
- Building PHP
Pull Request Checklist¶
- Pull requests to the
masterbranch are not accepted. Please fork the repository and create your branch from the necessary "source" branch, for instance,
4.0.x, and if need be rebase your branch before submitting your pull request. If there are collisions, we will ask you to rebase your branch again.
- Add tests to your pull request or adjust existing ones. This is very important since it helps justify your pull request. Please check our testing page for more information on how to set up a test environment and how to write tests.
- Since Phalcon is written in Zephir, please do not submit commits that modify the C-generated files directly
- Phalcon follows a specific coding style. Please install the
editorconfigplugin in your favorite IDE to take advantage of the supplied
.editorconfigfile that comes with this repository and not have to worry about coding standards. All tests (PHP code), follow the PSR-12 standard
- Remove any change to
*.zep.hfiles before submitting the pull request
- More information here.
Before submitting new functionality, please open a NFR as a new issue on GitHub to discuss the impact of including the functionality or changes in the core extension. Once the functionality is approved, make sure your PR contains the following:
- An update to the
- Unit Tests
- Documentation or Usage Examples
If you have any questions about how to use Phalcon, please see the support page.
If you have any changes or new features in mind, please fill out an NFR.
<3 Phalcon Team