Obtendo uma revisão por pares para o meu novo plugin?

8

Qual é a melhor maneira de obter um desenvolvedor experiente do WordPress? Dê uma olhada no meu plugin e faça críticas construtivas? Eu escrevi código para resolver algumas das minhas perguntas neste site, e acho que elas podem ser úteis para os outros também. No entanto, como eles seriam usados pelos meus primeiros plug-ins públicos do WordPress, e já vi muitos exemplos não muito bons no diretório público do WordPress, gostaria de saber "onde estou" e como posso melhorar meus plug-ins. Eu li as lista de melhores práticas , e ainda preciso aplicar alguns deles, mas eu também gostaria de uma resposta para a pergunta mais geral "Esta é uma boa maneira de resolver este problema?"

Acabei de reler discussão relacionada sobre wp-hackers ( Eu não percebi que os participantes também estavam tão envolvidos neste site, e que a questão das "melhores práticas" é um resultado direto disso. Não tenho certeza se minhas necessidades seriam cobertas por esse sistema, e concordo com Paulo preocupações :

  

Quando eu li os comentários originais sobre este tópico na semana passada, pensei que o propósito era montar um processo de revisão por pares, onde o desenvolvedor de plugins pode oferecer conselhos a outros desenvolvedores de plugins como revisão de seu código. Eu originalmente tomei este conselho como algo ao longo das linhas de "Bem, o seu código funciona, mas este conjunto de rotinas que você escreveu seria melhor servido se você apenas se conectasse a este filtro WP e tentasse essa técnica (veja xxx plugin como um exemplo) ". O objetivo que eu pensei foi compartilhar o conhecimento de desenvolvimento do plugin WP e fazer qualquer desenvolvedor de plugin medíocre um desenvolvedor melhor. Como eu mesmo.

Esse seria um escopo diferente do que fazer uma revisão de lista de verificação ponto a ponto, seria mais uma "orientação". Parece que há muitas pessoas dispostas a fazer isso, e (ainda melhor) muitas delas participam aqui neste site, então como podemos transformar toda essa energia em algo concreto?

Meu exemplo atual são três plugins que eu escrevi para resolve meu problema" redimensionar imagem ". Escrevi longos comentários introdutórios para cada plugin, o que (espero) facilita a compreensão das minhas intenções sem ler o código completo. Há mais alguma coisa que eu possa fazer para tornar mais fácil para os outros darem uma olhada? Por favor, ignore minha solicitação concreta atual. Não é só muito cedo para eles, mas mudei de ideia e não quero estragar a discussão geral com a minha situação específica.

    
por Jan Fabry 15.11.2010 / 11:43

3 respostas

4

A maneira mais fácil é uma abordagem em duas etapas:

  1. Liberte o seu plug-in para o público. Quando estiver em direto, começará a obter feedback dos utilizadores finais, para além dos programadores. Se você quiser, libere-o como uma versão "beta" e enfatize strongmente isso no arquivo leia-me.
  2. Pergunte. Existem desenvolvedores veteranos do WordPress em todos os lugares: aqui, na lista de WP-Hackers, em empregos no WordPress , perseguição @wordpress no Twitter, etc. É apenas uma questão de jogar seu plug-in e pedir feedback.

Em geral, siga as mesmas etapas que você faria com um patch do Core analisado por um desenvolvedor:

  • Escreva
  • Documente
  • Entre em contato com um desenvolvedor (seja de forma ampla por meio de um dos canais acima ou diretamente, se puder) e peça feedback

No que diz respeito a transformar o tipo de "mentoria" que ocorre neste site em algo mais concreto, isso seria um processo orgânico. Como você já mencionou, os esforços para criar um tipo de processo de revisão de plug-in antes realmente revisar qualquer coisa parecem ter parado. A única maneira de obter algo do começo é na verdade começar a fazê-lo. Portanto, não fale apenas sobre encontrar um desenvolvedor veterano e obter feedback, sair, encontrar um, receber seu feedback e anotar como foi o processo.

Em seguida, ele pode ser repetido com futuros plug-ins e futuros desenvolvedores. Mas você tem que começar em algum lugar ...

    
por EAMann 15.11.2010 / 22:08
1

Depois de uma rápida olhada no enlace , vi alguns pontos menores, principalmente sobre legibilidade:

  • Escreva uma boa documentação de código: Docblocks… e comentários in-line sempre que algo não estiver absolutamente claro.
  • Divida as funções do looong em funções separadas mais curtas. Eles são mais fáceis de ler e abordar nos comentários do revisor.
  • Alinhe seus operadores de atribuição, adicione espaço em branco entre parênteses.
  • 80 caracteres de comprimento de linha, por favor! O Eclipse ainda não consegue quebrar linhas longas. : (
  • Mantenha seu código "deixado", salve recuos. Em vez de:

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

… escreva…

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

Eu escrevi um novo plugin só esta noite… e eu queria saber se posso fazer exatamente a sua pergunta. Bom momento. :)

    
por fuxia 15.11.2010 / 13:21
0

Isso só me fez pensar no Appscan: enlace ; enlace versão trial da versão light: enlace

Isso pode fazer php e pode-se colocar regras extras para verificar as coisas. Dessa forma, uma parte pode ser automatizada (como algumas das melhores práticas, como na resposta do toscho), ela pode verificar a segurança, os padrões de codificação, as otimizações, etc.

Estou apenas dizendo: se uma ferramenta puder verificar 80%, as verificações de 20% das verificações manuais de um guru serão menores. Também ajudaria a gerar relatórios de conformidade para o uso de um plug-in em uma grande empresa que exige esse tipo de coisa em torno de códigos adicionais.

Nós automatizamos as coisas para outras pessoas, então por que não para nós mesmos?

    
por edelwater 15.11.2010 / 23:54