Git と GitHub

Braze Docs に貢献できるように、Git と GitHub の使い方を学びましょう。

前提条件

まだの場合は、Braze Docs への貢献のステップを完了します。

ブランチの作成

新しい Git ブランチを作成するには、developまずブランチをチェックアウトしてローカル環境を更新します。

1
2
git checkout develop
git pull

Git checkout のコマンドを使用して新しい Git ブランチを作成します。

1
git checkout -b BRANCH_NAME

BRANCH_NAMEブランチの変更点をスペースで区切らない短い説明に置き換えてください。出力は次のようになるはずです。

1
2
$ git checkout -b fixing-typo-in-metadata
Switched to a new branch 'fixing-typo-in-metadata'

プルリクエストの作成

プルリクエスト (PR) を作成するには、まずブランチをチェックアウトします。

1
git checkout BRANCH_NAME

BRANCH_NAME前に作成したブランチの名前に置き換えてください。出力は次のようになるはずです。

1
2
$ git checkout fixing-typo-in-metadata
Switched to branch 'fixing-typo-in-metadata'

変更を追加し、コミットをステージングします。

1
2
git add --all
git commit -m "COMMIT_MESSAGE"

COMMIT_MESSAGE変更内容を説明する短い文に置き換えてください。出力は次のようになるはずです。

1
2
3
$ git commit -m "Fixing a typo in the recommended software doc
[fixing-typo-in-recommended-software 8b05e34] Fixing a typo in the metadata doc.
 1 file changed, 1 insertion(+), 1 deletion(-)

最後に、変更を Braze Docs GitHub リポジトリにプッシュしてください。

1
git push -u origin BRANCH_NAME

BRANCH_NAMEあなたの支店の名前に置き換えてください。出力は以下のようになります。

1
2
3
4
5
6
$ git push -u origin fixing-typo-in-recommended-software
Enumerating objects: 14, done.
...
To github.com:braze-inc/braze-docs.git
 * [new branch]      fixing-typo-in-recommended-software -> fixing-typo-in-recommended-software
branch 'fixing-typo-in-recommended-software' set up to track 'origin/fixing-typo-in-recommended-software'.

次に、Braze Docs GitHub リポジトリに移動し、「比較とプルリクエスト」を選択します。

PRの説明には、次のようなMarkdownのコメントが表示されます。これらのコメントを PR の記入に役立ててください。

```markdown ```

完了したら、プルリクエストのドロップダウンを選択し、[ドラフトプルリクエスト] を選択します。

レビューをリクエストする

Braze Docs チームのメンバーに PR レビューをリクエストするには、以前に作成した PR を開いて [レビューの準備完了] を選択します。

レビュアーとタイプbraze-inc/docs-team。チーム名を選択して [Esc] を押すか、ドロップダウンをクリックして選択を確定します。

Braze Docs チームがレビュー後に追加の変更を要求した場合、GitHub の通知設定に従って通知されます。変更が不要な場合は、チームが変更を承認してマージします。

承認された寄付金は、次の火曜日または木曜日に配布されます。必ず Braze Docs をチェックして、頑張ったことを祝いましょう。貢献していただきありがとうございます！