cat docs

Bienvenue à Cat Docs - Un projet open source documentant les chats!

L'idée de ce projet est de combiner toutes les informations liées aux chats dans un site Web - qu'il s'agisse de conseils pour posséder un chat en tant que animal de compagnie, apprenant l'historique des chats, tous les produits de chat, vous l'appelez.

N'hésitez pas à contribuer et à créer de nouveaux problèmes pour tout commentaire ou questions que vous avez! Ceci est un projet sur tout et tout ce qui concerne les chats, alors n'hésitez pas à explorer!

Pour les débutants

• N'hésitez pas à ouvrir de nouveaux problèmes et à commenter ceux existants si vous souhaitez assumer des tâches. L'aide est toujours la bienvenue!

Merci d'avoir visité Cat Docs!

? Lignes directrices de contribution:

Commencer

Configurez le projet localement en suivant ces étapes:

1. Fourchez le référentiel :

   • Cliquez sur le bouton "Fork" dans le coin supérieur droit de la page du référentiel pour créer une copie du référentiel sous votre propre compte GitHub.

2. Clone votre fourche :

   • Clone le référentiel fourchu vers votre machine locale à l'aide de la commande suivante:

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

     Remplacez your-username par votre nom d'utilisateur GitHub.

3. Accédez au répertoire du projet :

    cd cat-docs

4. Installez les dépendances :

   • Installez les dépendances requises à l'aide du gestionnaire de package de votre choix. Par exemple, avec NPM:

     npm install

5. Exécutez le projet :

   • Démarrez le projet à l'aide de la commande VitePress pour s'assurer que tout fonctionne correctement:

     npm run docs:dev

Contributif

1. Parcourez les problèmes :

   • Parcourez les problèmes pour en trouver un qui vous intéresse. Commentez la question pour faire savoir aux mainteneurs que vous aimeriez y travailler. Le problème vous sera alors attribué.

2. Créer une branche :

   • Créez une nouvelle branche pour votre travail. Utilisez un nom descriptif qui se rapporte au problème que vous résolvez. Par exemple:

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

3. Faites vos modifications :

   • Implémentez vos modifications et engagez-les dans votre succursale. Suivez les normes de codage du projet et engagez les directives de messages.

4. Poussez votre branche :

   • Poussez votre branche vers votre référentiel à fourche:

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

5. Soumettre une demande de traction (PR) :

   • Accédez au référentiel d'origine sur GitHub et vous devriez voir une invite pour créer une demande de traction. Cliquez sur "Comparez et tirez la demande".

6. Examen et approbation des relations publiques :

   • Votre demande de traction sera examinée par les responsables. Veuillez être patient et réactif à tous les commentaires que vous recevez. Seuls les responsables ont le pouvoir de fusionner et de déployer vos modifications.

Apprendre encore plus

Pour des informations plus détaillées sur le travail avec les fourches et la contribution à des projets open source, consultez le guide de GitHub sur le travail avec les fourchettes.