Guía para colaboradores de Mchain Docs
¡Bienvenido a la comunidad de Mchain Docs! Agradecemos enormemente tu interés en mejorar nuestra documentación. Aquí tienes una guía rápida sobre cómo puedes contribuir de manera efectiva.
Visión general
Para asegurar la consistencia y calidad en nuestra documentación:
- Comenzando: Familiarízate antes de contribuir.
- Formas de contribuir: Entiende los diferentes métodos para ofrecer tu experiencia.
- Ideas para contribuir: Obtén claridad sobre qué contribuciones pueden ser más impactantes.
Comenzando
Antes de sumergirte:
- Identifica problemas yendo a la sección de Issues y proporcionando detalles completos.
- Busca ayuda técnica o aclaraciones en la plataforma designada si es necesario.
- Si planeas contribuir directamente al repositorio, tu contribución podría incluir lo siguiente:
- Corregir ortografía o gramática.
- Refinar el formato del código.
- Arreglar enlaces rotos.
Todas las contribuciones deben hacerse a través de una solicitud de extracción (pull request). Cada solicitud debe abordar un único tema o corrección.
Si no estás familiarizado con GitHub o la creación de solicitudes de extracción, hay varias guías para principiantes disponibles en GitHub para ayudarte.
Formas de contribuir
El repositorio maestro contiene la documentación principal para el portal docs.mchain.network, dirigido principalmente a los desarrolladores de Mchain.
Pequeñas correcciones
Para ajustes menores, como ediciones de texto:
- Haz clic en "Editar esta página".
- Realiza las correcciones directamente en GitHub.
- Describe brevemente tus cambios en el mensaje de confirmación y haz la confirmación.
- Elige "Crear una nueva rama para esta confirmación e iniciar una solicitud de extracción".
Ramificación y solicitudes de extracción
Para actualizaciones significativas:
- Visita el repositorio público mchain-docs.
- Haz un fork o clona el repositorio localmente.
- Crea una nueva rama usando un comando similar a:
git switch -c tus-iniciales/nombre-de-la-rama
Sigue los pasos subsiguientes similares al ejemplo proporcionado para finalizar tus actualizaciones. Luego, inicia una solicitud de extracción para revisión.
Ideas para contribuir
Las contribuciones valiosas a menudo vienen en guías detalladas o tutoriales para apoyar a otros desarrolladores.
Si estás contemplando una contribución, aquí hay una distinción entre una "guía detallada" y un "tutorial":
Guías detalladas
Estas proporcionan instrucciones claras para alcanzar objetivos específicos. Enfatizan pasos esenciales y excluyen información no relacionada.
Tutoriales
Los tutoriales son lecciones completas paso a paso para lectores nuevos en el tema. Guían al lector desde el principio hasta el final en una tarea específica.
Tus perspectivas mejorarán significativamente Mchain Docs. Esperamos tu aporte. ¡Celebra cada contribución exitosa! 🚀