<rmcreative>

RSS

OpenSource-им PHP код

19 августа 2014

Недавно Максим 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.

Комментарии RSS

  1. №9132
    Максим
    Максим 19.08.2014, 19:19:21

    Согласен со всем. Часть пунктов общая с форумными. Я оставил в той теме ссылку на этот пост. Думаю они прекрасно дополняют друг друга.

  2. №9136
    chesar
    chesar 21.08.2014, 11:12:32

    Если позволите оставлю это здесь: www.phptherightway.com/

  3. №9137
    Sam
    Sam 21.08.2014, 13:09:10

    chesar, оно у меня в сайдбаре →

  1. Почта опубликована не будет.

  2. Можно использовать синтаксис Markdown или HTML.

  3. Введите ответ в поле. Щёлкните, чтобы получить другую задачу.