cat docs

Bienvenido a Cat Docs, ¡un proyecto de código abierto que documenta gatos!

La idea de este proyecto es combinar toda la información relacionada con los gatos en un sitio web, ya sea que se trate de consejos para ser dueño de un gato como mascota, aprendizaje de la historia de los gatos, todos los productos para gatos, lo que sea.

¡Siéntase libre de contribuir y crear nuevos problemas para cualquier comentario o pregunta que tenga! Este es un proyecto sobre todo y cualquier cosa relacionada con los gatos, ¡así que no dude en explorar!

Para principiantes

• Siéntase libre de abrir nuevos problemas y comentar sobre los existentes si desea asumir tareas. ¡La ayuda siempre es bienvenida!

¡Gracias por visitar Cat Docs!

? Pautas de contribución:

Empezando

Configure el proyecto localmente siguiendo estos pasos:

1. Bifurca el repositorio :

   • Haga clic en el botón "Bifurque" en la esquina superior derecha de la página del repositorio para crear una copia del repositorio en su propia cuenta GitHub.

2. Clon tu tenedor :

   • Clon el repositorio bifurcado a su máquina local utilizando el siguiente comando:

     git clone https://github.com/your-username/cat-docs.git

     Reemplace your-username con su nombre de usuario GitHub.

3. Navegue al directorio del proyecto :

    cd cat-docs

4. Instalar dependencias :

   • Instale las dependencias requeridas utilizando el Administrador de paquetes de su elección. Por ejemplo, con NPM:

     npm install

5. Ejecute el proyecto :

   • Inicie el proyecto utilizando el comando VitePress para asegurarse de que todo funcione correctamente:

     npm run docs:dev

Que contribuye

1. Explorar los problemas :

   • Mira los problemas para encontrar uno que te interese. Comente el tema para que los mantenedores sepan que le gustaría trabajar en ello. El problema se le asignará.

2. Crear una rama :

   • Crea una nueva rama para tu trabajo. Use un nombre descriptivo que se relacione con el problema que está abordando. Por ejemplo:

     git checkout -b issue-123-add-cat-facts

3. Haga sus cambios :

   • Implemente sus cambios y compromételos con su rama. Siga los estándares de codificación del proyecto y las pautas de mensajes de confirmación.

4. Empuja tu rama :

   • Empuje su rama a su repositorio bifurcado:

     git push origin issue-123-add-cat-facts

5. Envíe una solicitud de extracción (PR) :

   • Vaya al repositorio original en GitHub y debería ver un mensaje para crear una solicitud de extracción. Haga clic en "Comparar y extraer solicitud".

6. Revisión y aprobación de relaciones públicas :

   • Su solicitud de extracción será revisada por los mantenedores. Sea paciente y responda a cualquier comentario que reciba. Solo los mantenedores tienen la autoridad para fusionar e implementar sus cambios.

Obtenga más información

Para obtener información más detallada sobre el trabajo con horquillas y contribuir a proyectos de código abierto, consulte la guía de GitHub sobre cómo trabajar con horquillas.