|
Есть несколько требований, которые должны соблюдаться для того,
чтобы ваш код был добавлен в PEAR:
Соответствие стандартам кодирования
Если вы хотите добавить ваш код в PEAR, то он обязательно должен
соответствовать стандартам кодирования.
В свое время, после множества дискуссий о том, нужны стандарты или нет,
было принято решение - необходимы. Пожалуйста, не пытайтесь продолжить
споры на эту тему.
Должна быть возможность расширения кода и добавления новой функциональности ("forward-compatible" code).
Помните: ваш код должен легко расширяться, добавление новой
функциональности не должно вызывать никаких проблем. Если у вас
никак не получается сделать подобный код без изменения принципов
работы кода, то вам, видимо, еще рано добавлять код в PEAR,
попробуйте перепроектировать код.
Документация в соответствующих форматах (plain text, docbook)
Ваш код должен поставляться с соответствующей документацией в одном из
следующих форматов:
Если вы создадите документацию в формате Docbook XML и
разметка будет соответствовать всем правилам, то документация
будет сразу же добавлена в официальное
справочное руководство по PEAR,
которое вы читаете в данный момент.
Замечание:
Существуют планы реализовать автоматическую систему
конвертации формата PHPDoc
в формат Docbook XML, который уже будет добавляться в официальное
руководство автоматически. Но пока вам придется писать документацию
вручную.
Автор кода ("вы") должен иметь желание и возможность
поддерживать в будущем свой пакет (или пакеты) и выпускать новые версии
для исправления ошибок.
Если у вас нет желания поддерживать ваш код, это значит, что
добавлять его в PEAR нет смысла. Поддержка кода - это в первую
очередь оказание помощи другим разработчикам, которые используют
ваш пакет, в основном с помощью
листов рассылки,
а также выпуск новых релизов кода, исправление ошибок и
улучшение функциональности.
Внимание |
Код может быть удален из PEAR, если его автор не желает более
заниматься его поддержкой и никто другой такого желания не проявляет.
|
|