Articles /

WordPress.org

os atuais esforços de documentação em Linha do WordPress realmente começaram a começar no ciclo de lançamento 3.7 e ganharam impulso à medida que a iniciativa Hook docs avançava. A inline documentation, ou iniciativa “inline docs”, é um projeto híbrido, reportando ao CoreCore Core é o conjunto de software necessário para executar o WordPress. A equipe de desenvolvimento principal cria o WordPress., Documentação e equipes do Developer Hub.

o que é documentação inline? #O que é documentação inline?

a documentação Inline fornece informações necessárias e úteis na forma de comentários inline, blocos doc e muito mais dentro do código-fonte do próprio WordPress.

a documentação embutida é analisada com cada versão, e essa documentação é exibida na Referência de código em developer.wordpress.orgWordPress.org o site da comunidade onde o código WordPress é criado e compartilhado pelos usuários. É aqui que você pode baixar o código-fonte do WordPress core, plugins e temas, bem como o local central para conversas e organização da comunidade. https://wordpress.org/.

Top

como se envolver #como se envolver

a documentação embutida é considerada documentação “técnica”, portanto, será necessária alguma familiaridade com a base de código do WordPress – você precisa entender o código para escrever sobre isso.

1. Familiarize-se com o padrão de documentação do PHP, bem como com as Diretrizes de formatação e as dicas de documentação.

2. Configure uma cópia local da versão do desenvolvedor da base de código do WordPress usando vagrant Vagrants (VVV) variados. WordPress é versionamento usando SVNSVN Apache Subversion (muitas vezes abreviado SVN, após seu nome de comando svn) é um software de controle de versão e revisão sistema. Os desenvolvedores de Software usam o Subversion para manter versões atuais e históricas de arquivos, como código-fonte, páginas da web e documentação. Seu objetivo é ser um sucessor Principalmente Compatível com o amplamente utilizado Sistema de versões simultâneas (CVS). WordPress core e o wordpress.org o código liberado é gerenciado centralmente por meio do SVN. https://subversion.apache.org/., mas você também pode usar o Gitgit Git é um sistema de controle de Versão Distribuído gratuito e de código aberto projetado para lidar com tudo, desde projetos pequenos a muito grandes, com velocidade e eficiência. Git é fácil de aprender e tem uma pequena pegada com um desempenho extremamente rápido. O desenvolvimento mais moderno de plugins e temas está sendo feito com este sistema de controle de versão. https://git-scm.com/. (o link VVV para saber como fazer isso).

3. Ler abrir um Ticket para saber como criar um TracTrac Trac é o lugar onde os colaboradores criam problemas para bugs ou solicitações de recursos, como o GitHub.https://core.trac.wordpress.org/. bilhete.

4. Criando patches:

  • sempre atualize sua cópia local do tronco do WordPress antes de editar o arquivo e criar patches. Use svn up ou git pull, conforme apropriado.
  • gere o patch a partir do diretório raiz do seu SVN WordPress ou Git checkout. Por exemplo, svn diff dir/filename.php > function_name.diff.

5. Como enviar um patch

há um patch para relatar as falhas de documentação em linha e
por exemplo, #48303 é esse patch para o WordPress 5.4.

  • Adicionar comentário e anexar arquivo de patch.

6. Você também pode contribuir para tickets Trac relacionados a documentos embutidos que precisam de iteração.

  • se um ticket estiver marcado como needs-patch ou needs-refresh, é possível que o patch(es) existente precise apenas de um retoque ou seja atualizado contra o tronco mais recente. Cada pedacinho ajuda!

topo

pontos de Contato # pontos de contato

para qualquer dúvida, pop pelos canais # docs ou # core-docs no Slack.

Top

Resources # Resources

  • PHP Documentation Standard
  • Adam Brown’s Hooks Database (útil para dicas sobre as versões @since de hooksHooks em WordPress theme and development, hooks são funções que podem ser aplicadas a uma ação ou a um filtro no WordPress. Ações são funções executadas quando um determinado evento ocorre no WordPress. Os filtros permitem modificar certas funções. Argumentos usados para conectar filtros e ações têm a mesma aparência.)

Top

como abrir um novo ticket de documento #como abrir um novo ticket de Documento

basicamente, há um ticket para relatar as falhas e melhorias da documentação embutida. Mas, se você precisar criar um novo ticket por algum motivo, siga as etapas abaixo:

  1. leia abrindo um Ticket para saber como criar um ticket Trac.
  2. crie um novo ticket no Core Trac para o arquivo:
    • os formatos de Título sugeridos podem ser “correção PHPDoc para path/to/file.php ” ou ” melhorar a documentação para path / to / file.pai”.
    • o tipo deve ser defeito (bug).
    • atribua o ticket ao componente ao qual o arquivo está associado.
    • deixe a versão em branco.
    • adicione o foco do docs clicando nele.
  3. Envie seu patch para o ticket Trac criado e adicione a palavra-chave has-patch.
  4. certifique-se de deixar um comentário descrevendo seu patch recém-carregado. Simplesmente enviar patches não aciona uma notificação para quem assiste ao ticket.

Nota: as alterações de documentação não devem ser misturadas com alterações de código (mesmo whitespacing), a menos que o ticket chame especificamente para ambos.

última atualização: 26 de outubro de 2019

Leave a Reply