Вклад в проект

Мы приветствуем вклад участников и будем признательны за него.

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

Этикет

Этот проект является открытым исходным кодом, и его сопровождающие тратят своё свободное время на создание и поддержку исходного кода. Они делают код доступным бесплатно в надежде, что он будет полезен другим разработчикам. Было бы крайне несправедливо, если бы они страдали от оскорблений или гнева из-за своей тяжёлой работы.

Просим вас быть внимательными к сопровождающим при создании задач или представлении запросов на вытягивание. Давайте покажем миру, что разработчики — цивилизованные и бескорыстные люди.

Обязанность сопровождающего — убедиться, что все материалы, представленные проекту, имеют достаточное качество, чтобы принести пользу проекту. У многих разработчиков разные навыки, сильные и слабые стороны. Уважайте решение сопровождающего и не расстраивайтесь и не оскорбляйте его, если ваша работа не будет использована.

Жизнеспособность

Когда вы запрашиваете или предлагаете новые функции, сначала подумайте, могут ли они быть полезны другим. Открытые проекты используются многими разработчиками, у которых могут быть совершенно другие потребности, чем у вас. Подумайте, будет ли ваша функция использоваться другими пользователями проекта.

Процедура

Перед подачей проблемы:

• Попробуйте воспроизвести проблему, чтобы убедиться, что это не случайный инцидент.
• Проверьте, не присутствует ли уже ваше предложение в проекте.
• Посмотрите вкладку запросов на вытягивание, чтобы убедиться, что исправление ошибки не находится в процессе разработки.
• Посмотрите вкладку запросов на вытягивание, чтобы убедиться, что функция уже не разрабатывается.

Прежде чем отправить запрос на вытягивание:

• Проверьте кодовую базу, чтобы убедиться, что ваша функция ещё не существует.
• Просмотрите запросы на вытягивание, чтобы убедиться, что другой человек уже не отправил эту функцию или исправление.

Требования

Если у сопровождающего проекта есть какие-либо дополнительные требования, вы найдёте их здесь.

• PSR-2 Coding Standard — Самый простой способ применить соглашения — установить PHP Code Sniffer.

• Добавьте тесты! — Ваш патч не будет принят, если в нём нет тестов.

• Документируйте любые изменения в поведении — Убедитесь, что README.md и любая другая соответствующая документация обновлены.

• Учитывайте наш цикл выпуска — Мы стараемся следовать SemVer v2.0.0. Случайное нарушение публичных API не вариант.

• Один запрос на вытягивание для каждой функции — Если вы хотите сделать более одной вещи, отправьте несколько запросов на вытягивание.

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

Счастливого кодирования!