cat docs

Bem -vindo ao Cat Docs - um projeto de código aberto que documenta gatos!

A idéia deste projeto é combinar todas as informações relacionadas aos gatos em um site - seja sobre dicas para possuir um gato como animal de estimação, aprender história de gatos, todos os produtos de gatos, você escolhe.

Sinta -se à vontade para contribuir e criar novos problemas para qualquer feedback ou perguntas que você tenha! Este é um projeto sobre tudo e qualquer coisa relacionada a gatos, então fique à vontade para explorar!

Para iniciantes

• Sinta -se à vontade para abrir novos problemas e comentar sobre os existentes, se quiser assumir tarefas. A ajuda é sempre recebida!

Obrigado por visitar documentos de gatos!

? Diretrizes de contribuição:

Começando

Configure o projeto localmente seguindo estas etapas:

1. Fork o repositório :

   • Clique no botão "Fork" no canto superior direito da página do repositório para criar uma cópia do repositório sob sua própria conta do GitHub.

2. Clone o seu garfo :

   • Clone o repositório bifurcado à sua máquina local usando o seguinte comando:

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

     Substitua your-username pelo seu nome de usuário do Github.

3. Navegue até o diretório do projeto :

    cd cat-docs

4. Instale dependências :

   • Instale as dependências necessárias usando o gerenciador de pacotes de sua escolha. Por exemplo, com o NPM:

     npm install

5. Execute o projeto :

   • Inicie o projeto usando o comando vitepress para garantir que tudo esteja funcionando corretamente:

     npm run docs:dev

Contribuindo

1. Navegue pelos problemas :

   • Veja as questões para encontrar uma que lhe interessa. Comente o assunto para que os mantenedores saibam que você gostaria de trabalhar nele. O problema será atribuído a você.

2. Crie uma filial :

   • Crie uma nova filial para o seu trabalho. Use um nome descritivo relacionado ao problema que você está abordando. Por exemplo:

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

3. Faça suas alterações :

   • Implemente suas mudanças e comprometa -as com sua filial. Siga os padrões de codificação do projeto e comprometa as diretrizes de mensagens.

4. Empurre seu ramo :

   • Empurre seu ramo para o repositório bifurcado:

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

5. Envie uma solicitação de tração (PR) :

   • Vá para o repositório original no Github e você verá um aviso para criar uma solicitação de tração. Clique em "Compare & Pull Request".

6. Revisão e aprovação de relações públicas :

   • Sua solicitação de tração será revisada pelos mantenedores. Por favor, seja paciente e responsivo a qualquer feedback que você receber. Somente os mantenedores têm autoridade para mesclar e implantar suas alterações.

Saber mais

Para obter informações mais detalhadas sobre o trabalho com garfos e contribuir para projetos de código aberto, consulte o Guia do Github sobre o trabalho com garfos.