Требования к новому коду

Есть несколько требований, которые должны соблюдаться для того, чтобы ваш код был добавлен в PEAR:

  1. Соответствие стандартам кодирования

    Если вы хотите добавить ваш код в PEAR, то он обязательно должен соответствовать стандартам кодирования. В свое время, после множества дискуссий о том, нужны стандарты или нет, было принято решение - необходимы. Пожалуйста, не пытайтесь продолжить споры на эту тему.

  2. Должна быть возможность расширения кода и добавления новой функциональности ("forward-compatible" code).

    Помните: ваш код должен легко расширяться, добавление новой функциональности не должно вызывать никаких проблем. Если у вас никак не получается сделать подобный код без изменения принципов работы кода, то вам, видимо, еще рано добавлять код в PEAR, попробуйте перепроектировать код.

  3. Документация в соответствующих форматах (plain text, docbook)

    Ваш код должен поставляться с соответствующей документацией в одном из следующих форматов:

    Если вы создадите документацию в формате Docbook XML и разметка будет соответствовать всем правилам, то документация будет сразу же добавлена в официальное справочное руководство по PEAR, которое вы читаете в данный момент.

    Существуют планы реализовать автоматическую систему конвертации формата phpDocumentor в формат Docbook XML, который уже будет добавляться в официальное руководство автоматически. Но пока вам придется писать документацию вручную.

  4. Автор кода ("вы") должен иметь желание и возможность поддерживать в будущем свой пакет (или пакеты) и выпускать новые версии для исправления ошибок.

    Если у вас нет желания поддерживать ваш код, это значит, что добавлять его в PEAR нет смысла. Поддержка кода - это в первую очередь оказание помощи другим разработчикам, которые используют ваш пакет, в основном с помощью листов рассылки, а также выпуск новых релизов кода, исправление ошибок и улучшение функциональности.

    Код может быть удален из PEAR, если его автор не желает более заниматься его поддержкой и никто другой такого желания не проявляет.

Добавление вашего кода (Previous) Как добавить свой код в PEAR (Next)
Last updated: Sat, 20 Sep 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.