Об этом проекте
PHP: The Right Way — это легкое для чтения справочное руководство по лучшим практикам PHP, принятым стандартам кодирования и ссылкам на авторитетные руководства в интернете. Проект открыто заявляет о своей мотивации: сообществу PHP не хватало достаточного количества достоверной информации для начинающих программистов, и этот сайт призван восполнить этот пробел.
Структура сайта и репозитория:
- Веб-сайт представляет собой проект Jekyll, размещенный на GitHub Pages.
- Каждый раздел и подраздел является файлом Markdown в папке _posts/, при этом подразделы помечены как isChild: true в их front matter.
- Навигация и структура страниц генерируются автоматически из этих файлов.
Стандарты контента: Примеры кода от участников должны соответствовать стандарту PSR-1 или выше. Руководство по стилю для участников требует использования американского английского правописания (только для основного англоязычного репозитория), отступов в четыре пробела вместо табов и переноса строк по достижении 120 символов.
Участие в проекте: Участники читают файл CONTRIBUTING.md для получения подробных инструкций, затем создают форк и вносят правки, опционально устанавливают Ruby с гемом Jekyll для локального предпросмотра изменений и отправляют pull request. Проект также предоставляет баннеры, которые сторонники могут разместить на своих сайтах, чтобы направлять новых разработчиков PHP к этому ресурсу.
Переводы: Документ доступен на многих языках помимо английского, включая испанский, французский, индонезийский, итальянский, польский, бразильский португальский, румынский, словенский, сербский, турецкий, болгарский, русский, украинский, арабский, персидский, тайский, корейский, японский, упрощенный китайский и традиционный китайский. Новые переводы создаются путем форка репозитория и публикации локализованного форка на GitHub Pages, либо как [username].github.io/php-the-right-way, либо как поддомен, настроенный через файл CNAME; затем мейнтейнеры добавляют ссылку на готовый перевод в основной документ во избежание фрагментации.
Авторство и лицензия: Проект поддерживается Джошем Локхартом, автором фреймворка Slim, в сотрудничестве с Крисом Джорданом и Филом Стурдженом. Контент публикуется под лицензией Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.