Участие в проекте

Как помочь развитию TrueAsync — код, документация, тестирование и сообщество

Статус проекта ​

PHP TrueAsync — неофициальный проект по изменению ядра PHP. RFC, которое предлагается, в настоящее время находится в неопределённой ситуации, и неясно, будет ли оно принято в будущем.

Тем не менее я как автор проекта верю в то, что наличие выбора является важным условием развития. Проект PHP TrueAsync открыт для идей, предложений и помощи.

Если хотите обсудить что-то — пишите на форуме проекта или свяжитесь со мной лично:

Способы участия ​

Код ​

  • Исправление багов — в трекере задач есть issues с меткой good first issue, с которых удобно начать знакомство с проектом
  • Новые возможности — будем рады обсудить вашу идею в Discussions до начала реализации
  • Ревью кода — рецензирование pull requests — очень ценный вклад

Документация ​

  • Исправления — нашли неточность? Нажмите «Редактировать страницу» внизу любой страницы
  • Переводы — помогите перевести документацию на другие языки
  • Примеры — напишите примеры использования API для реальных сценариев
  • Туториалы — создайте пошаговое руководство для конкретной задачи

Тестирование ​

  • Тестирование сборок — попробуйте установить TrueAsync на своей системе и расскажите, как прошло
  • Написание тестов — увеличьте покрытие тестами для существующего API
  • Нагрузочное тестирование — помогите найти узкие места производительности

Сообщество ​

  • Отвечайте на вопросы в GitHub Discussions и Discord
  • Рассказывайте о проекте — доклады, статьи, посты в блогах
  • Сообщайте о проблемах — подробный баг-репорт экономит часы разработки

Как начать ​

1. Форкните репозиторий ​

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

2. Настройте окружение ​

Следуйте инструкции по сборке для вашей платформы. Для разработки рекомендуется сборка с --debug:

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

3. Создайте ветку ​

bash
git checkout -b feature/my-improvement

4. Внесите изменения ​

  • Следуйте стилю кода проекта
  • Добавьте тесты для нового функционала
  • Убедитесь, что существующие тесты проходят: make test

5. Отправьте Pull Request ​

  • Опишите что и зачем вы изменили
  • Укажите связанные issues
  • Будьте готовы к обсуждению и доработкам

Структура репозиториев ​

РепозиторийОписание
php-srcЯдро PHP с Async API
php-asyncРасширение с реализацией
true-async.github.ioЭтот сайт с документацией

Рекомендации ​

  • Маленькие PR лучше больших — один PR решает одну задачу
  • Обсуждайте перед реализацией — для крупных изменений создайте issue или discussion
  • Пишите тесты — код без тестов сложнее принять
  • Документируйте — обновляйте документацию при изменении API

Связь ​

Спасибо за интерес к проекту! Любой вклад — будь то код, документация или просто вопрос на форуме — помогает TrueAsync становиться лучше.