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

8

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

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

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

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

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

plugin-development customization Ян Фабри
источник

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

Рафаэль

2

@ Рафаэль: Я только что сделал, не так ли? :-) Но я хотел обобщить свой вопрос, чтобы другие тоже сочли его полезным. Возможно, есть некоторые общие рекомендации, которым можно следовать, чтобы облегчить просмотр их плагина.

Ян Фабри

4 года спустя ... вы когда-нибудь выпускали эти плагины? Суть в том, что они все еще на полпути, но это все равно кажется хорошей идеей.

Моралейда

@moraleida Google - твой друг - gist.github.com/janfabry

patrickzdb

4

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

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

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

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

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

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

EAMann
источник

Спасибо за ответ. Одна вещь, которая удерживала меня от непосредственного обращения к вам, Майку или другим влиятельным авторам, заключается в том, что я не хочу навязывать вам и «заставлять» вас делать то, что вы не хотели бы делать, но слишком вежливы, чтобы снижение. И, возможно, было бы лучше получить некоторую обратную связь, прежде чем я выпустил плагин, чтобы предотвратить меня и его пользователей от возможных глупостей.

Ян Фабри

1. Не работает для меня. У меня было несколько сотен скачиваний, но ни одного голоса на wordpress.org.

Рафаэль

@Raphael Голосов на WordPress.org не реальная обратная связь с самого начала. Тот факт, что вы не получили жалоб или сообщений об ошибках, означает, что это, скорее всего, работает, и ваши конечные пользователи удовлетворены. Теперь, когда он находится в репозитории, разработчикам стало проще получить и просмотреть исходный код. На этом этапе вы должны перейти к шагу 2 и попросить опытного разработчика взглянуть и дать некоторую обратную связь.

EAMann

1

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

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

,

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

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

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

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

Фуксия
источник

Спасибо за ваши первые комментарии. Возможно, я был немного слишком ранним, поскольку мне действительно нужно тщательно редактировать код, чтобы привести его в соответствие со стандартами кодирования, чтобы было легче сосредоточиться на содержании. Хорошее замечание о правиле "оставь раньше, чтобы сохранить отступы", но я предполагаю, что дополнительные 4 пробела в каждой строке твоего второго примера являются непреднамеренными?

Ян Фабри

Хм, да, Markdown исказил форматирование после списка. Я исправлю это.

fuxia

Спасибо за ваши комментарии, но я перечитал оригинальное обсуждение в списке wp-хакеров и решил расширить сферу применения, убрав мой конкретный запрос из вопроса. Это означает, что ваш ответ больше не подходит, возможно, вы захотите удалить его.

Ян Фабри

0

Это заставило меня задуматься о 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% проверок для ручных проверок для гуру будет меньше. Это также помогло бы создать отчеты о соответствии для использования плагина в большой компании, которая требует такого рода вещей вокруг дополнительного кода.

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

edelwater
источник

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

Ответы: