获得我的新插件的同行评价?


8

让经验丰富的WordPress开发人员看一下我的插件并提出建设性的批评的最佳方法是什么?我已经在该站点上编写了代码来解决我的一些问题,我认为它们对其他人也可能有用。但是,由于他们是我的第一个公共WordPress插件,并且在公共WordPress目录中看到了很多不太理想的示例,因此我想知道“我的立场”以及如何改进我的插件。我已经阅读了最佳实践列表,并且仍然需要应用其中的一些最佳实践,但是我还想回答一个更笼统的问题:“这是解决此问题的好方法吗?”

我只是重新阅读了有关的讨论wp-hackers(我没有意识到参与者也是如此参与该站点,而“最佳实践”问题是它的直接结果)。我不确定这样的系统是否可以满足我的需求,并且我同意Paul的担心

上周,当我阅读有关该线程的原始评论时,我的目的是将同行评审过程组合在一起,在此过程中,插件开发人员可以向其他插件开发人员提供建议,以作为对其代码的审查。我最初将这个建议作为“可以使用您的代码,但是如果您只是挂接到此WP过滤器并尝试了此技术,则可以更好地使用您编写的这组例程(请参见xxx插件为例)” ”。我的目标是分享WP插件开发知识,并使任何平庸的插件开发人员成为更好的开发人员。像我自己。

这与进行逐点检查清单审查的范围有所不同,它更像是“指导”。似乎有很多人愿意这样做,而且(甚至更好)很多人都参加了此站点,所以我们如何将所有这些能量转化为具体的东西?

我当前的示例是为解决“图像调整大小”问题而编写的三个插件。我为每个插件写了很长的介绍性注释,(希望如此)可以使我更容易地理解我的意图,而无需阅读完整的代码。我还能做些什么使别人更容易看一下? 请忽略我当前的具体要求。他们不仅为时过早,而且我改变了主意,不想因自己的具体情况破坏一般性讨论。


这里似乎有一些资深的插件编码人员,所以为什么不在这里问呢?
拉斐尔

2
@Raphael:我刚刚做到了,不是吗?:-)但是我想归纳一下我的问题,所以其他人可能也会觉得它很有用。也许可以遵循一些通用准则,以使其插件更易于查看。
Jan Fabry

4年后...您曾经发布这些插件吗?要点表明,他们仍处于中途,但这似乎还是个好主意。
Morideida 2014年

@moraleida Google是您的朋友-gist.github.com/janfabry
patrickzdb 2014年

Answers:


4

最简单的方法是两步方法:

  1. 向公众发布您的插件。 上线之后,您将开始从开发人员以及其他最终用户那里获得反馈。如果需要,可以将其作为“ beta”版本发布,并在自述文件中特别强调。
  2. 问。 到处都有经验丰富的WordPress开发人员:在这里,在WP-Hackers列表上,在WordPress职位上,在Twitter上跟踪@wordpress等,这仅仅是将插件扔在那里并征求反馈的问题。

通常,请按照与开发人员查看Core补丁相同的步骤进行操作:

  • 写下来
  • 记录下来
  • 与开发人员联系(或者通过上述渠道之一,或者直接联系您),以征询反馈

至于将发生在该站点上的“指导”的类型转换为更具体的东西,那将是一个有机过程。正如您已经提到的,实际审查任何内容之前创建一种插件审查流程的工作似乎已经停滞。摆脱困境的唯一方法就是真正开始做。因此,不要仅仅谈论寻找资深开发人员并获得反馈,外出寻找,获取反馈并写下流程进行的方式。

然后,将来的插件和将来的开发人员可以重复进行此操作。但是你必须从某个地方开始...


谢谢回复。令我无法直接问您,迈克或其他知名人士的一件事是,我不想强​​加于您,“强迫”您做一些您不愿做的事情,但是太客气了下降。而且,我发布插件之前最好先获得一些反馈,以防止我及其用户出现愚蠢现象。
Jan Fabry

1.没有为我工作。我已经下载了数百次,但对wordpress.org却一无所获。
拉斐尔

最初并不是WordPress.org上的@Raphael投票。您没有受到投诉或收到任何错误报告的事实,这意味着它很可能正在工作并且您的最终用户感到满意。但是,既然它已经在存储库中,那么开发人员就可以更轻松地获取和查看源代码。此时,您应该继续执行步骤2,并资深开发人员看一下并提供一些反馈。
EAMann

1

快速浏览https://gist.github.com/675437之后,我看到了一些小问题,主要是关于可读性的:

  • 编写良好的代码文档:Docblocks…并在某些事情不太清楚时内联注释。
  • 将looong函数拆分为较短的单独函数。它们更易于阅读和在审阅者的评论中解决。
  • 对齐您的赋值运算符,在括号之间添加空格。
  • 请输入80个字符的行长!Eclipse仍然无法换行。:(
  • 保持代码“向左”,保存缩进。代替:

。  

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

……写……

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

我只是在今晚写了一个新的插件……我想知道是否可以问您一个问题。好时机。:)


感谢您的初步评论。也许我还为时过早,因为我确实需要进行彻底的编辑,以使代码与编码标准保持一致,以便更轻松地关注内容。关于“提早保存缩进”规则的要点,但是我认为第二个示例的每行上多余的4个空格是无意的吗?
Jan Fabry

嗯,是的,Markdown破坏了列表后面的格式。我会解决的。
fuxia

感谢您的评论,但我重新阅读了wp-hackers列表上的原始讨论,并决定扩大范围,从问题中删除我的具体要求。这意味着您的答案不再那么适合,也许您可​​能想要删除它。
Jan Fabry

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%检查就更少了。这也将有助于生成合规性报告,以供大型公司中的插件使用,这些插件需要围绕其他代码进行此类操作。

我们为别人自动化事情,为什么不为我们自己?

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.