CONTRIBUTING.md

リポジトリへの貢献ガイド

このドキュメントでは、リポジトリへの貢献方法を説明します。

事前にGitHubアカウントを作成し、ローカルマシンでGitのセットアップを済ませてください。

問題を報告する

リポジトリにバグなどの問題を報告するにはIssueを作成します。Issueは、リポジトリに関する議論や問題解決のための重要な手段です。

注意: 問題に脆弱性が含まれる場合は、Issueを通して報告しないでください。必ずメンテナーに直接連絡するようにお願いします。

1. リポジトリのページにアクセスします。
2. 上部のメニューから「Issues」タブをクリックします。
3. 「New issue」ボタンをクリックします。
4. Issueのタイトルと詳細を記入します。バグ報告の場合は、再現手順や期待する動作も記載してください。
5. 「Submit new issue」ボタンをクリックしてIssueを作成します。

変更を提案する

1. リポジトリをフォークする

まずリポジトリを自分のアカウントにフォークします。

1. リポジトリのページにアクセスします。
2. 画面右上の「Fork」ボタンをクリックします。

2. リポジトリをクローンする

フォークしたリポジトリを自分のローカルマシンにクローンします。

1. 自分のGitHubアカウントにある、フォークしたリポジトリのページにアクセスします。

2. 「Code」ボタンをクリックし、表示されるURLをコピーします。

3. ターミナルを開き、以下のコマンドを実行します：

   git clone コピーしたURL

3. 新しいブランチを作成する

変更を加える前に、mainブランチから分岐する新しいブランチを作成します。

1. ターミナルでリポジトリのディレクトリに移動します：

   cd フォルダ名

2. 新しいブランチを作成してチェックアウトします：

   git checkout -b 新しいブランチ名

4. 変更を加える

プロジェクトに必要な変更を加えます。変更内容が完成したら、コミットします。

テストなどの指示がある場合は必ず従ってください。

1. 変更をステージします：

   git add .

2. 変更をコミットします：

   git commit -m "変更内容の短い説明"

5. リモートリポジトリにプッシュする

ローカルの変更を自分のGitHubリポジトリにプッシュします。

1. 以下のコマンドを実行します：

   git push origin ブランチ名

6. プルリクエストを作成する

GitHub上でプルリクエスト（Pull Request）を作成し、変更内容を元のリポジトリに提案します。

1. 自分のGitHubリポジトリのページにアクセスします。
2. 「Compare & pull request」ボタンをクリックします。
3. 変更内容を記載し、「Create pull request」ボタンをクリックします。

7. コードレビューとフィードバック

プルリクエストが作成されると、リポジトリのメンテナーがコードレビューを行います。フィードバックがあった場合は、指示に従って修正を行い、再度プッシュします。

不明点や質問がある場合は、気軽にissueを作成して問い合わせてください。皆さんの貢献をお待ちしております！🌟