RMCreative.ru - Блог Голосов: 1 Адрес блога: http://rmcreative.ru/feed/ Добавлен: 2008-06-12 21:34:00 блограйдером ZaiSL

OpenSource-им PHP код

Недавно Максим Ekstazi Фуртуна написал тему для авторов кода на форуме yiiframework.ru. Я решил сделать подобный список для современного PHP-кода в общем.

• Пишите под поддерживаемые версии PHP. Сейчас это 5.4 и выше.
• Форматируйте код по PSR-2.
• Используйте git, а лучше github.
• Релизы делайте по правилам семантического версионирования.
• Используйте Composer и не забывайте добавить пакет в packagist.
• Называйте и загружайте классы по стандарту PSR-4. Писать свой загрузчик не нужно, Composer уже умеет.
• Пишите unit-тесты. Замечательно, если ваш код покрыт ими на 70-80%. Запускать автоматически можно через Travis CI.
• Документируйте код в стиле DocBlocks.
• Напишите отличный readme: что код делает, как настроить и использовать. Получилось длинно — оставляйте в readme «что код делает», остальное выносите в полноценное руководство. В качестве разметки советую markdown.
• Не забрасывайте свой код. Если времени нет — подключите к проекту тех, кто активнее всех вам помогает и заинтересован.
• Обязательно приложите текст одной из OpenSource-лицензий. Рекомендую BSD или MIT.