Contributing

Project Status ​

PHP TrueAsync is an unofficial project to modify the PHP core! The RFC being proposed is currently in an uncertain situation, and it is unclear whether it will be accepted in the future.

Nevertheless, as the author of the project, I believe that having a choice is an important condition for progress. The PHP TrueAsync project is open for ideas, suggestions and help.

If you'd like to discuss something — write on the project forum or contact me personally:

Ways to Contribute ​

Code ​

• Bug fixes — check open issues labeled good first issue to get started
• New features — discuss your idea in Discussions before implementing
• Code review — help review pull requests, it's a valuable contribution

Documentation ​

• Corrections — found an inaccuracy? Click "Edit this page" at the bottom of any page
• Translations — help translate the documentation into other languages
• Examples — write API usage examples for real-world scenarios
• Tutorials — create step-by-step guides for specific tasks

Testing ​

• Build testing — try installing TrueAsync on your system and report any issues
• Writing tests — increase test coverage for the existing API
• Load testing — help find performance bottlenecks

Community ​

• Answer questions on GitHub Discussions and Discord
• Spread the word — talks, articles, blog posts
• Report bugs — a detailed bug report saves hours of development time

Getting Started ​

1. Fork the Repository ​

git clone https://github.com/true-async/php-src.git
cd php-src

2. Set Up Your Environment ​

Follow the build instructions for your platform. For development, a debug build is recommended:

./buildconf
./configure --enable-async --enable-debug
make -j$(nproc)

3. Create a Branch ​

git checkout -b feature/my-improvement

4. Make Your Changes ​

• Follow the project's code style
• Add tests for new functionality
• Make sure existing tests pass: make test

5. Submit a Pull Request ​

• Describe what and why you changed
• Reference related issues
• Be prepared for discussion and revisions

Repository Structure ​

Guidelines ​

• Small PRs are better than large ones — one PR solves one task
• Discuss before implementing — for major changes, create an issue or discussion first
• Write tests — code without tests is harder to accept
• Document your work — update docs when changing the API

Get in Touch ​

• GitHub Discussions — questions and ideas
• Discord — live chat
• Issues — bug reports

Thank you for contributing to the future of PHP!