cat docs

CAT Docsへようこそ - 猫を文書化するオープンソースプロジェクト！

このプロジェクトのアイデアは、猫に関連するすべての情報を1つのウェブサイトに組み合わせることです。それがペットとして猫を所有するためのヒント、猫の歴史を学ぶ、すべての猫製品、あなたはそれに名前を付けます。

フィードバックや質問のために、お気軽に貢献して新しい問題を作成してください！これは、猫に関連するあらゆるものに関するプロジェクトですので、お気軽に探索してください！

初心者向け

• タスクを引き受けたい場合は、新しい問題を自由に開き、既存の問題についてコメントしてください。ヘルプは常に歓迎されます！

猫のドキュメントを訪問してくれてありがとう！

？貢献ガイドライン：

はじめる

これらの手順に従って、プロジェクトをローカルに設定します。

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's Guide on Work with Forksをご覧ください。