cat docs

Cat Docs에 오신 것을 환영합니다 - Cats를 문서화하는 오픈 소스 프로젝트!

이 프로젝트의 아이디어는 고양이와 관련된 모든 정보를 하나의 웹 사이트로 결합하는 것입니다. 고양이를 애완 동물로 소유하고 고양이 역사, 모든 고양이 제품을 소유하기위한 팁에 관한 것입니다.

피드백이나 질문에 대한 새로운 문제를 자유롭게 기여하고 만들 수 있습니다! 이것은 고양이와 관련된 모든 것에 대한 프로젝트이므로 자유롭게 탐색하십시오!

초보자를 위해

• 작업을 수행하려면 새로운 문제를 열고 기존 문제에 대해 자유롭게 의견을 제시하십시오. 도움이 항상 환영됩니다!

고양이 문서를 방문해 주셔서 감사합니다!

? 기여 지침 :

시작하기

다음 단계를 수행하여 프로젝트를 로컬로 설정하십시오.

1. 저장소 포크 :

   • 저장소 페이지의 오른쪽 상단에있는 "Fork"버튼을 클릭하여 자신의 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 검토 및 승인 :

   • 풀 요청은 관리자가 검토합니다. 받은 피드백에 인내하고 대응하십시오. 유지 관리자 만 변경 및 배포 할 권한이 있습니다.

자세히 알아보십시오

포크 작업 및 오픈 소스 프로젝트에 대한 자세한 정보는 Forks 작업에 대한 Github의 안내서를 확인하십시오.