Инструкция по вкладу

Эта страница содержит руководство по вкладу в проект PHPHub. Пожалуйста, ознакомьтесь с этими рекомендациями перед отправкой любых запросов на слияние в проект.

Инструкция по вкладу основана на руководстве по вкладу Laravel.

Запросы на слияние

Процесс запросов на слияние отличается для новых функций и багфиксов.

Новые функции

Перед отправкой запроса на слияние для новой функции вы должны сначала создать задачу с [Proposal] в названии.

Предложение должно описать новую функцию, а также идеи по её реализации.

Предложение будет затем проверено и либо одобрено, либо отклонено.

Если предложение одобрено, можно создать запрос на слияние для реализации новой функции.

Баги

Запросы на слияние для исправления ошибок могут быть отправлены без создания какой-либо задачи предложения.

Если вы считаете, что знаете решение для ошибки, которая была зарегистрирована на GitHub, пожалуйста, оставьте комментарий со своим предлагаемым решением.

Запросы на новые функции

Если у вас есть идея для новой функции, которую вы хотели бы видеть добавленной в PHPHub, вы можете создать задачу на GitHub с [Request] в названии. Запрос на новую функцию будет затем проверен @summerblue.## Кодовые стандарты

Проект PHPHub следует кодовым стандартам PSR-0, PSR-1 и PSR-2.

Хотя текущее состояние кодовой базы ещё не соответствует этим стандартам, запросы на слияние требуют соблюдения этих кодовых стандартов.

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

Использование документации кода обязательно. Новый код, который не документирован с помощью docblocks для функций, будет отвергнут.

Когда пишете @param или @return, рекомендуется использовать полное пространство имён вместо ссылки. Это повышает читаемость, позволяя сразу понять тип объекта, с которым вы работаете.

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

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