Получаете рецензию на мой новый плагин?

Как лучше всего заставить опытного разработчика WordPress взглянуть на мой плагин и дать конструктивную критику? Я написал код для решения некоторых моих вопросов на этом сайте, и я думаю, что они могут быть полезны и для других. Однако, так как они были бы моими первыми общедоступными плагинами WordPress, и я видел много не очень хороших примеров в общедоступном каталоге WordPress, я хотел бы знать, «где я нахожусь», и как я могу улучшить свои плагины. Я прочитал список лучших практик и все еще должен применить некоторые из них, но мне также хотелось бы получить ответ на более общий вопрос: «Это хороший способ решить эту проблему?»

Я просто перечитал соответствующую дискуссиюwp-hackers (я не осознавал, что участники также были настолько вовлечены в этот сайт, и что вопрос «передового опыта» является его прямым результатом). Я не уверен, что моя система могла бы покрыть мои потребности, и я согласен с опасениями Пола :

Когда я прочитал оригинальные комментарии к этой теме на прошлой неделе, я подумал, что цель состояла в том, чтобы собрать процесс рецензирования, где разработчик плагинов может дать совет другим разработчикам плагинов в качестве обзора их кода. Первоначально я воспринял этот совет как что-то вроде «Хорошо, ваш код работает, но этот набор подпрограмм, которые вы написали, будет лучше обслуживаться, если вы просто подключитесь к этому WP-фильтру и попробуете эту технику (см. Пример плагина xxx) ». Я думал о том, чтобы поделиться знаниями по разработке плагинов WP и сделать любого посредственного разработчика плагинов лучшим разработчиком. Как я

Это было бы иной областью, нежели проведение поэтапной проверки, это было бы скорее «наставничество». Кажется, есть много людей, желающих сделать это, и (даже лучше), многие из них участвуют здесь на этом сайте, так как мы можем преобразовать всю эту энергию в нечто конкретное?

Мой текущий пример - три плагина, которые я написал, чтобы решить мою проблему изменения размера изображения . Я написал длинные вступительные комментарии к каждому плагину, что (надеюсь) облегчает понимание моих намерений без чтения полного кода. Могу ли я сделать что-нибудь еще, чтобы другим было проще взглянуть на это? Пожалуйста, игнорируйте мой текущий конкретный запрос. Для них не только слишком рано, но я передумал и не хочу портить общую дискуссию своей конкретной ситуацией.

Самый простой способ - двухэтапный подход:

1. Выпустите свой плагин для общественности. Как только он появится, вы начнете получать отзывы от конечных пользователей и разработчиков. Если вы хотите, выпустите его как «бета-версию» и подчеркните это в файле readme.
2. Спросить. Ветеран-разработчики WordPress есть повсюду: здесь, в списке WP-хакеров, на рабочих местах WordPress , отслеживании @wordpress в Твиттере и т. Д. Это всего лишь вопрос установки вашего плагина и получения обратной связи.

В общем, выполните те же шаги, что и при поиске исправления Core разработчиком:

• Напиши это
• Документируйте это
• Свяжитесь с разработчиком (либо через один из вышеперечисленных каналов, либо напрямую, если можете) и попросите отзыв

Если преобразовать вид «наставничества», который происходит на этом сайте, во что-то более конкретное, это будет органический процесс. Как вы уже упоминали, усилия по созданию своего рода процесса проверки плагинов перед тем, как на самом деле рассматривать что-либо, похоже, затормозились. Единственный способ оторваться от земли - это начать это делать. Так что не просто говорите о том, чтобы найти опытного разработчика и получить обратную связь, выйдите, найдите его, получите свой отзыв и запишите, как прошел процесс.

Затем это можно повторить с будущими плагинами и будущими разработчиками. Но вы должны начать где-нибудь ...

После быстрого просмотра https://gist.github.com/675437 я увидел некоторые незначительные моменты, в основном о читабельности:

• Пишите хорошую документацию по коду: докблоки… и встроенные комментарии, когда что-то не совсем понятно.
• Разделите функции Looong на более короткие отдельные функции. Их легче читать и адресовать в комментариях рецензента.
• Выровняйте свои операторы присваивания, добавьте пробел в скобках.
• Длина строки 80 символов, пожалуйста! Затмение до сих пор не может обернуть длинные строки. :(
• Держите свой код »слева«, сохраните отступы. Вместо:

,  

public function checkUrl()
{
    if (is_404()) {
        // code
    }
}

… записывать …

public function checkUrl()
{
    if ( ! is_404() ) {
        return;
    }
    // code
}

Я написал новый плагин только сегодня вечером ... и мне было интересно, могу ли я задать именно ваш вопрос. Хорошее время. :)

Это заставило меня задуматься о Appscan: http://www01.ibm.com/software/rational/products/appscan/source/ ; http://www-01.ibm.com/software/rational/products/appscan/source/features/ пробная версия облегченной версии: http://www-01.ibm.com/software/awdtools/appscan/express/

Это может сделать php, и в него можно добавить дополнительные правила для проверки. Таким образом, часть может быть автоматизирована (как некоторые лучшие практики, как в ответе toscho), она может проверять безопасность, стандарты кодирования, оптимизации и т. Д.

Я просто говорю: если инструмент может проверить на 80%, то 20% проверок для ручных проверок для гуру будет меньше. Это также помогло бы создать отчеты о соответствии для использования плагина в большой компании, которая требует такого рода вещей вокруг дополнительного кода.

Мы автоматизируем вещи для других людей, так почему бы не для себя?