Ir al contenido principal

Contribuir

ūüéČūüĎć En primer lugar, ¬°gracias por tomarse el tiempo para contribuir!ūüéČūüĎć! ūüéČūüĎć

Xplorer se encuentra actualmente en desarrollo. Estamos dando la bienvenida a los colaboradores que deseen ayudar en Xplorer.

Invol√ļcrate‚Äč

Hay muchas maneras de contribuir a Xplorer, y muchas de ellas no implican escribir nada código. Aquí tienes algunas ideas para empezar:

  • ¬°Empieza a usar Xplorer! Sigue los tutoriales. ¬ŅFunciona todo tal y como esperabas? Si no es as√≠, estamos siempre buscando mejoras. H√°ganos saber abriendo una issue.
  • Mira a trav√©s de los problemas de Xplorer. Si encuentras un problema que te gustar√≠a corregir, abre una issue. Los problemas etiquetados como primera issue son un buen lugar para empezar.
  • Ay√ļdanos a mejorar la documentaci√≥n. Crea un nuevo problema si encuentras algo que est√° siendo confuso, alg√ļn error gramatical, o si algo puede ser mejorado.
  • Echa un vistazo a la secci√≥n de conversaciones en GitHub y da tu opini√≥n sobre una discusi√≥n o considera abrir un pull request si ves algo en lo que quieres trabajar.

¬°Los contribuidores son siempre bienvenidos!

Nuestro proceso de desarrollo‚Äč

Xplorer utiliza GitHub como su fuente inicial. El equipo principal trabajar√° directamente all√≠. Todos los cambios ser√°n p√ļblicos desde el comienzo.

Reportando nuevos problemas/errores.‚Äč

Cuando abra un nuevo problema, siempre aseg√ļrese de rellenar la plantilla de problemas. Utilizamos problemas de GitHub para rastrear errores p√ļblicos. Por favor, aseg√ļrese de que su descripci√≥n es clara y tiene suficientes instrucciones para poder reproducir el problema.

  • Un problema, un error: Por favor, informe de un solo error por cada problema.
  • Proporciona pasos de reproducci√≥n: Lista todos los pasos necesarios para reproducir el problema. La persona que lea tu informe de fallo deber√≠a ser capaz de seguir estos pasos para reproducir su problema con un m√≠nimo esfuerzo.

Solicita una funcionalidad‚Äč

Utilizamos discusiones en GitHub y problemas en GitHub para rastrear ideas de usuarios. ¡Sugiere una nueva función aquí! Las buenas solicitudes de características tienden a tener:

  • Resumen r√°pido de la idea.
  • Qu√© & por qu√© quiere a√Īadir la caracter√≠stica espec√≠ficada.
  • Contexto adicional como im√°genes, enlaces a recursos para implementar la funci√≥n, etc.

Trabajando en el c√≥digo de Xplorer‚Äč

Prerequisitos‚Äč

Instalaci√≥n‚Äč

  1. Después de clonar el repositorio, ejecute yarn en la raíz del repositorio y ejecute yarn en la carpeta docs (si desea trabajar en Xplorer Docs).

  2. Para iniciar Xplorer localmente, ejecute yarn dev.

    Para iniciar un servidor de desarrollo local que sirva la documentación de Docusaurus, vaya al directorio docs y ejecute yarn start

Gitpod para el desarrollo de Xplorer‚Äč

La forma m√°s f√°cil de ejecutar Xplorer en Gitpod es utilizar el servicio de Gitpod, todo lo que necesitas hacer es hacer clic en el bot√≥n de abajo e iniciar sesi√≥n con tu cuenta de GitHub. Despu√©s, ver√°s un entorno similar al VS Code donde puedes comenzar a desarrollar y publicar tus cambios. Tenga en cuenta que puede tener que esperar hasta unos minutos para que Xplorer funcione en la pesta√Īa VNC desplegada.

Abrir en Gitpod‚Äč

Mensajes de confirmaci√≥n sem√°ntica‚Äč

Vea cómo un cambio menor en su estilo de mensaje de confirmación puede hacerle un mejor programador.

Formato: <type>(<scope>): <subject>

<scope> es opcional

Ejemplo‚Äč

función: permitir la sobreescritura de la configuración webpack
^--^ ^------------^
| |
| +-> Resumen en el tiempo actual.
|
+-------> Tipo: chore, docs, feat, fix, refactor, style, o test.

los distintos tipos de commits:

  • feat: nueva caracter√≠stica para el usuario
  • fix: correcci√≥n de errores para el usuario
  • docs: cambios a la documentaci√≥n
  • style: formateo, falta punto y coma y dem√°s.
  • refactor: refactorizar c√≥digo de producci√≥n, por ejemplo. renombrando una variable
  • test: a√Īadiendo pruebas faltantes, refactorizando pruebas.
  • chore: actualizar tareas grunt, etc

¬°Usar min√ļsculas no may√ļsculas!

Trabajando en el c√≥digo de Xplorer‚Äč

El sitio web de documentación de Xplorer se construye usando Docusaurus 2, y su código se encuentra en docs carpeta.

Prerequisitos‚Äč

Instalaci√≥n‚Äč

Después de clonar el repositorio, ejecuta yarn en la carpeta docs (puedes ir a la carpeta docs ejecutando el comando cd docs).

Si desea utilizar Gitpod, haga clic aquí para la guía sobre cómo usar Gitpod.

Desarrollo local‚Äč

  1. Ejecute el comando yarn start en la carpeta docs.
  2. Edite algunos textos de markdown en la carpeta de documentos y el sitio web ser√° recargado.

Solicitudes de incorporaci√≥n de cambios‚Äč

Su primera solicitud de incorporaci√≥n de cambios.‚Äč

Así que has decidido contribuir código de vuelta al autor abriendo una solicitud de pull request. Has invertido una buena parte de tiempo, y lo apreciamos. Haremos todo lo posible para trabajar con usted y conseguir que se analice el RP.

Trabajando en tu primera solicitud de Pull Request? Puedes aprender cómo de esta serie de vídeo gratis:

Cómo contribuir a un Proyecto de Código Abierto en GitHub

Tenemos una lista de problemas para principiantes para ayudarte a introducirte en el código base de Xplorer y familiarizarte con nuestro proceso de contribución. Es un gran lugar para empezar.

Proponiendo un Cambio‚Äč

Si desea solicitar una nueva caracter√≠stica o mejora pero a√ļn no est√° pensando en abrir una solicitud de pull request, tambi√©n puedes abrir una discusi√≥n y otros lo codificar√°n!

Si tiene la intención de arreglar un error, por favor hágalo a través de problemas antes de enviar una solicitud de incorporación de cambios.

Si tiene la intenci√≥n de a√Īadir una nueva caracter√≠stica, por favor discuta a trav√©s de discusiones en GitHub para evitar que varias personas trabajen en la misma solicitud de caracter√≠sticas.

Enviando una solicitud de incorporaci√≥n cambios‚Äč

aseg√ļrese de que el PR hace s√≥lo una cosa, de lo contrario por favor dividirla. Se recomienda seguir este estilo de mensaje de commit.

  1. Forkea el repositorio y cree su rama desde master.
  2. Haga cambios y aseg√ļrese de que su mensaje de confirmaci√≥n es comprensible.
  3. Abre un PR y aseg√ļrate de describir tu pull request claramente.

Trabajando en el c√≥digo de Xplorer‚Äč

Configuraci√≥n regional‚Äč

Alojamos nuestros locales en crowdin. Para solucionarlo, por favor sigue estos pasos:

  • Reg√≠strate en Crowdin y √önete a nuestro proyecto aqu√≠.
  • Aseg√ļrese de que su local existe all√≠, si no existe, deja un comentario en esta discusi√≥n y a√Īadir√© la opci√≥n de idioma :)
  • Familiar√≠cese con la interfaz de usuario de traducci√≥n de Crowdin, ya que deber√° usarla para traducir archivos JSON y Markdown
  • Traducir el contenido!

Archivos prioritarios para traducir en Crowdin‚Äč

  1. src/Locales
  2. docs/

Producci√≥n‚Äč

Una vez que los archivos en src/Locales han sido traducidos por m√°s del 80%, la a√Īadiremos a la aplicaci√≥n Xplorer y, para la documentacion, ¬°la a√Īadiremos a la producci√≥n una vez que la traducci√≥n parezca buena!

¡Por favor, comenta aquí si tienes alguna pregunta!

Biblioteca de Archivos‚Äč

La librer√≠a json de tipos de archivos y miniatura se encuentran en la carpeta lib y los iconos se encuentran en la carpeta src/Icons. Puedes a√Īadir tipos de archivos e iconos para las extensiones de archivo que quieras usar y enviar un PR.