cat docs

Добро пожаловать в Docs - проект с открытым исходным кодом, документирующий кошек!

Идея этого проекта состоит в том, чтобы объединить всю информацию, связанную с кошками, с одним веб -сайтом - будь то советы по владению кошкой в ​​качестве домашнего животного, изучении истории кошек, все продукты для кошек, вы называете это.

Не стесняйтесь вносить свой вклад и создавать новые проблемы для любых отзывов или вопросов! Это проект обо всем и обо всем, что связано с кошками, так что не стесняйтесь исследовать!

Для начинающих

• Не стесняйтесь открывать новые проблемы и комментировать существующие, если вы хотите выполнить задачи. Помощь всегда приветствуется!

Спасибо, что посетили документы для кошек!

? Руководящие принципы вклада:

Начиная

Настройте проект локально, выполнив эти шаги:

1. Вилка репозитория :

   • Нажмите кнопку «Вилка» в правом верхнем углу страницы репозитория, чтобы создать копию репозитория под вашей собственной учетной записью GitHub.

2. Клонировать свою вилку :

   • Клонировать разветвленный репозиторий в локальную машину, используя следующую команду:

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

     Замените your-username своим именем пользователя GitHub.

3. Перейдите к каталогу проекта :

    cd cat-docs

4. Установить зависимости :

   • Установите необходимые зависимости, используя диспетчер пакетов по вашему выбору. Например, с NPM:

     npm install

5. Запустите проект :

   • Начните проект, используя команду VitePress, чтобы убедиться, что все работает правильно:

     npm run docs:dev

Внося

1. Просмотрите проблемы :

   • Посмотрите на проблемы, чтобы найти то, что вас интересует. Прокомментируйте проблему, чтобы дать содействию знать, что вы хотите поработать над этим. Затем проблема будет назначена вам.

2. Создайте ветвь :

   • Создайте новый филиал для вашей работы. Используйте описательное имя, которое относится к проблеме, к которой вы обращаетесь. Например:

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

3. Внесите свои изменения :

   • Реализуйте свои изменения и посвятите их в свою филиал. Следуйте стандартам кодирования проекта и посвятите руководящие принципы сообщений.

4. Нажмите на свою ветвь :

   • Толкните свою ветвь в раздвоенный репозиторий:

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

5. Отправьте запрос на вытяжку (PR) :

   • Перейдите в исходный репозиторий на GitHub, и вы увидите подсказку для создания запроса на вытяжение. Нажмите «Сравните и вытащите запрос».

6. PR Обзор и одобрение :

   • Ваш запрос на вытягивания будет рассмотрено сопровождающими. Пожалуйста, будьте терпеливы и отвечают на любые отзывы, которые вы получаете. Только сопровождающие имеют право объединять и развернуть ваши изменения.

Узнать больше

Для получения более подробной информации о работе с вилками и участием в проектах с открытым исходным кодом, ознакомьтесь с руководством Github по работе с Forks.