Как внести свой вклад в мой исходный код

Этот документ описывает состав команды ThinkPHP и механизм работы. Он объясняет, какую пользу принесёт ваш код проекту ThinkPHP, и как присоединиться к нашей команде.

Вклад кода через GitHub

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

Процесс участия очень прост:

1. Скопируйте (fork) код ThinkPHP в свой репозиторий.
2. Внесите изменения и отправьте их.
3. Отправьте запрос на слияние (pull request). Мы рассмотрим ваш запрос и обработаем его. После проверки ваш код будет объединён с нашим репозиторием, и вы автоматически попадёте в список участников.

Мы ожидаем, что ваш код соответствует следующим требованиям:

• Соответствует стандартам кодирования ThinkPHP.
• Имеет адекватные комментарии, чтобы другие могли понять его.
• Следует лицензии Apache 2 с открытым исходным кодом.

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

Важные моменты

• В проекте используется стандарт форматирования кода PSR-2;
• Имена классов и имена файлов классов соответствуют стандарту PSR-4;
• Для обработки проблем (Issues) используйте заголовки коммитов типа «fix #xxx (Issue ID)» для закрытия проблемы.
• Система автоматически тестирует изменения на PHP 5.4, 5.5, 5.6, 7.0 и HHVM. Тестирование на HHVM допускает ошибки, поэтому убедитесь, что ваши изменения соответствуют синтаксису PHP 5.4–5.6 и PHP 7.0;
• Администратор не объединит изменения, которые приводят к сбою CI. Если это произошло, проверьте свой исходный код или соответствующие файлы модульных тестов.

GitHub предоставляет функцию Issues, которая может использоваться для:

• Отчёта об ошибках;
• Предложения улучшений;
• Обратной связи по опыту использования.

Эта функция не должна использоваться для:

• Выражения мнений о коде (включая авторские права и историю изменений);
• Недружелюбных высказываний.

Быстрое редактирование

GitHub предлагает функцию быстрого редактирования файлов:

1. Войдите в свою учётную запись GitHub.
2. Просмотрите файлы проекта и найдите файл для редактирования.
3. Нажмите на значок карандаша в правом верхнем углу для внесения изменений.
4. Введите соответствующую информацию (обязательно укажите заголовок).
5. Отправьте изменения и дождитесь проверки CI и объединения администратором.

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

Полный процесс

1. Скопируйте проект (fork).
2. Клонируйте (clone) скопированный проект на свой компьютер.
3. Создайте новую ветку (branch) и переключитесь на неё (checkout).
4. Добавьте этот проект в свой локальный репозиторий Git как вышестоящий (upstream).
5. Внесите изменения. Если ваши изменения включают добавление или удаление методов или функций, не забудьте обновить файлы модульного тестирования.
6. Перебазируйте (rebase) вашу ветку на основную ветку (master) вышестоящего репозитория.
7. Отправьте (push) свой локальный репозиторий на GitHub.
8. Отправьте запрос на слияние (pull request).
9. Дождитесь проверки CI (если она не пройдёт, повторите шаги 5–7, и GitHub обновит ваш запрос на слияние автоматически).
10. Подождите, пока администратор обработает запрос, и перебазируйте вашу ветку на основную ветку вышестоящего репозитория при необходимости (если в основной ветке были внесены изменения).

При необходимости вы можете принудительно отправить (push -f) перебазированную ветку в свой скопированный репозиторий (fork). Однако категорически запрещено использовать push -f для отправки изменений в вышестоящий репозиторий.

Обратите внимание:

• Если у вас остались вопросы по процессу, обратитесь к руководству по GIT, например, этому.
• Для разных аспектов кода рекомендуется создавать отдельные ветки в своём скопированном проекте (fork). Это объясняется в примечании к шагу 9 полного процесса.
• Информацию о перебазировании и интерактивном перебазировании можно найти в Git Interactive Rebase.

Рекомендуемые ресурсы

Среда разработки

• XAMPP for Windows 5.5.x
• WampServer (для Windows)
• upupw Apache PHP5.4 ( для Windows)

Или установите самостоятельно:

• Apache / Nginx
• PHP 5.4 ~ 5.6
• MySQL / MariaDB

Пользователи Windows могут добавить каталог bin PHP в PATH для удобства использования composer. Пользователи Linux могут настроить среду самостоятельно, а пользователи Mac могут использовать встроенный Apache в сочетании с Homebrew для установки PHP и MariaDB.

Редактор

Sublime Text 3 + плагин phpfmt. Параметры плагина phpfmt:

{
	"autocomplete": true,
	"enable_auto_align": true,
	"format_on_save": true,
	"indent_with_space": true,
	"psr1_naming": false,
	"psr2": true,
	"version": 4
}

Или другой редактор / IDE с поддержкой автоматического форматирования по PSR2.

Графический интерфейс Git

• SourceTree
• GitHub Desktop

Или любой другой графический клиент Git.