WordPress.org

Los esfuerzos actuales de documentación en línea de WordPress realmente comenzaron en el ciclo de lanzamiento de la versión 3.7, y cobraron impulso a medida que avanzaba la iniciativa hook docs. La iniciativa de documentación en línea, o” documentos en línea”, es un proyecto híbrido, la generación de informes al núcleo CoreCore es el conjunto de software necesario para ejecutar WordPress. El Equipo de Desarrollo Principal crea WordPress., Documentación y equipos del Centro de desarrolladores.

¿Qué es la documentación en línea? #¿ Qué es la documentación en línea?

La documentación en línea proporciona información necesaria y útil en forma de comentarios en línea, bloques de documentos y más dentro del código fuente de WordPress en sí.

La documentación en línea se analiza con cada versión, y esa documentación se muestra en la Referencia de código en developer.wordpress.orgWordPress.org El sitio de la comunidad donde el código de WordPress es creado y compartido por los usuarios. Aquí es donde puede descargar el código fuente para el núcleo, los complementos y los temas de WordPress, así como la ubicación central para las conversaciones y la organización de la comunidad. https://wordpress.org/.

Top

Cómo participar #Cómo participar

La documentación en línea se considera documentación “técnica”, por lo que será necesario un poco de familiaridad con la base de código de WordPress: debe comprender el código para escribir sobre ella.

1. Familiarícese con el Estándar de Documentación de PHP, así como con las pautas de formato y los consejos de documentación.

2. Configure una copia local de la versión para desarrolladores de la base de código de WordPress utilizando Vagrant Vagrants (VVV) variable. WordPress es un sistema de control de versiones usando SVNSVN Apache Subversion (a menudo abreviado SVN, después de su nombre de comando svn) es un sistema de control de versiones y revisiones de software. Los desarrolladores de software usan Subversion para mantener versiones actuales e históricas de archivos como código fuente, páginas web y documentación. Su objetivo es ser un sucesor en su mayoría compatible con el ampliamente utilizado Sistema de Versiones Concurrentes (CVS). El núcleo de WordPress y el wordpress.org el código liberado se administra de forma centralizada a través de SVN. https://subversion.apache.org/., pero también puedes usar GitGit Git es un sistema de control de versiones distribuido de código abierto y gratuito diseñado para manejar todo, desde proyectos pequeños hasta muy grandes, con velocidad y eficiencia. Git es fácil de aprender y tiene una huella pequeña con un rendimiento increíblemente rápido. El desarrollo de plugins y temas más moderno se realiza con este sistema de control de versiones. https://git-scm.com/. (el enlace VVV para saber cómo hacerlo).

3. Lea Abrir un Ticket para aprender a crear un TracTrac Trac es el lugar donde los colaboradores crean problemas para errores o solicitudes de funciones, como GitHub.https://core.trac.wordpress.org/. billete.

4. Creación de parches:

• Actualice siempre su copia local del tronco de WordPress antes de editar el archivo y crear parches. Utilizar svn up o git pull, según proceda.
• Genere el parche desde el directorio raíz de su SVN de WordPress o Git checkout. Por ejemplo, svn diff dir/filename.php > function_name.diff.

5. Cómo enviar un parche

Hay un parche para informar de los errores de documentación en línea y
Por ejemplo, #48303 es dicho parche para WordPress 5.4.

• Añadir comentario y adjuntar archivo de parche.

6. También puede contribuir a tickets Trac relacionados con documentos en línea que necesiten iteración.

• Si un ticket está marcado como needs-patch o needs-refresh, es posible que los parches existentes solo necesiten un retoque o que se actualicen en el último tronco. ¡Todo ayuda!

Top

Puntos de contacto #Puntos de contacto

Para cualquier duda, pop por el #docs o #core-docs canales de Holgura.

Top

Recursos # Recursos

• Estándar de documentación PHP
• Base de datos de ganchos de Adam Brown (útil para obtener sugerencias sobre las versiones @since de hooksHooks En el tema y desarrollo de WordPress, los ganchos son funciones que se pueden aplicar a una acción o un filtro en WordPress. Las acciones son funciones que se realizan cuando ocurre un determinado evento en WordPress. Los filtros le permiten modificar ciertas funciones. Los argumentos utilizados para enganchar filtros y acciones tienen el mismo aspecto.)

Top

Cómo abrir un nuevo ticket de documento # Cómo abrir un nuevo ticket de documento

Básicamente, hay un ticket para informar de los errores y mejoras de la documentación en línea. Pero, si necesita crear un nuevo ticket por alguna razón, siga los pasos a continuación:

1. Lea Abrir un ticket para aprender a crear un ticket Trac.
2. Cree un nuevo ticket en Core Trac para el archivo:
   • Los formatos de título sugeridos podrían ser ” Corrección PHPDoc para ruta / a / archivo.php ” o ” Mejorar la documentación para la ruta / al / archivo.php”.
   • El tipo debe ser defect (bug).
   • Asigne el ticket al componente al que está asociado el archivo.
   • Deje la versión en blanco.
   • Agregue el enfoque de documentos haciendo clic en él.
3. Cargue su parche en el ticket Trac que creó y agregue la palabra clave has-patch.
4. Asegúrese de dejar un comentario que describa el parche recién cargado. La simple carga de parches no activa una notificación para nadie que vea el ticket.

Nota: Los cambios de documentación no deben mezclarse con cambios de código (incluso espacios en blanco) a menos que el ticket llame específicamente a ambos.

Última actualización: 26 de octubre de 2019