我的新插件得到同行评审了吗?

时间:2010-11-15 作者:Jan Fabry

让有经验的WordPress开发人员查看我的插件并提出建设性的批评,最好的方法是什么?我已经在这个网站上写了一些代码来解决我的一些问题,我认为它们对其他人也很有用。然而,由于它们是由我的第一个公共WordPress插件提供的,而且我在公共WordPress目录中看到了许多不太好的例子,因此我想知道“我的立场”,以及如何改进我的插件。我读过the list of best practices, 仍然需要应用其中的一些,但我也想回答一个更一般的问题“这是解决这个问题的好方法吗?”

我只是重读了一遍the related discussion on wp-hackers (我不知道参与者也参与了这个网站,而“最佳实践”问题是它的直接结果)。我不确定这样一个系统能满足我的需要,我同意Paul\'s concerns:

上周,当我读到关于这个帖子的原始评论时,我认为其目的是建立一个同行评审过程,插件开发人员可以在评审代码时向其他插件开发人员提供建议。我最初把这条建议看作是“好吧,你的代码可以工作,但如果你只是连接到这个WP过滤器并尝试这种技术(请参阅xxx插件作为示例),那么你编写的这组例程会更好地发挥作用”。我的目标是分享WP插件开发知识,让任何平庸的插件开发人员成为更好的开发人员。就像我自己一样。

这将是一个不同于逐点检查表审查的范围,更像是一种“指导”。似乎有很多人愿意这样做,而且(甚至更好)他们中的许多人都参与了这个网站,那么我们如何才能将所有的能量转化为具体的东西呢?

我当前的示例是我编写的三个插件solve my "image resize" problem. 我为每个插件写了很长的介绍性评论,这(我希望)可以让我不必阅读完整的代码就可以更容易地理解我的意图。我还能做些什么让其他人更容易看一看吗

3 个回复
最合适的回答,由SO网友:EAMann 整理而成

最简单的方法是分两步进行:

  1. Release your plug-in to the public. 一旦上线,您将开始从最终用户和开发人员那里获得反馈。如果需要,可以将其作为“beta”版本发布,并在自述文件中重点强调这一点
  2. Ask. 到处都有经验丰富的WordPress开发人员:这里,在WP黑客列表中,在WordPress jobs, 跟踪@wordpress 在推特上等等。这只是把你的插件扔出去并征求反馈的问题
一般来说,按照开发人员查看核心补丁的步骤进行操作:

写下它,记录它,联系开发人员(广泛地通过上述渠道或直接联系,如果可以的话),并征求反馈,将本网站上出现的“指导”转化为更具体的东西,这将是一个有机的过程。正如您已经提到的,在实际审查任何内容之前创建一种插件审查过程的努力似乎已经停滞。要想让一切顺利进行,唯一的办法就是真正开始做。所以,不要只谈论找到一位经验丰富的开发人员并获得反馈,走出去,找到一位,获得反馈,然后写下过程是如何进行的。

然后,它可以在未来的插件和开发人员中重复。但你必须从某个地方开始。。。

SO网友:fuxia

快速查看后https://gist.github.com/675437 我看到了一些次要观点,主要是关于可读性:

编写好的代码文档:Docblocks…和内联注释,只要有不完全清楚的地方

  • 保留代码»左«,保存缩进。而不是:
  • public function checkUrl()
    {
        if (is_404()) {
            // code
        }
    }
    
    …写入…

    public function checkUrl()
    {
        if ( ! is_404() ) {
            return;
        }
        // code
    }
    
    就在今晚,我写了一个新插件……我想知道我是否可以确切地问一下你的问题。好时机。:)

    SO网友:edelwater

    这让我想起了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%检查就会更少。它还将有助于生成法规遵从性报告,以便在需要附加代码的大型公司中使用插件。

    我们为他人实现自动化,为什么不为自己实现呢?

    结束

    相关推荐