初めての寄付

最近のほとんどのテキストエディター (VS Code や Intellij IDEA など) には、コマンドを実行したりプロジェクトファイルを操作したりするためのアプリ内ターミナルが用意されています。テキストエディターを開き、テキストエディターのアプリ内ターミナルを開きます。

ターミナルで、braze-docsディレクトリを開きます。

1
cd ~/PATH_TO_REPOSITORY

PATH_TO_REPOSITORYbraze-docs環境を設定したときにリポジトリを保存した場所に置き換えてください。コマンドは次のようになるはずです。

1
cd ~/braze/braze-docs

braze-docsディレクトリにいるかどうかを確認し、Git のステータスを確認します。

1
2
pwd
git status

ドキュメントリポジトリでは、developブランチには最新バージョンの Braze Docs が反映されています。developブランチをチェックして、最新のアップデートをローカル環境に取り込んでください。

1
2
git checkout develop
git pull

ドキュメントに変更を加えるときは、必ず新しいブランチを作成します。git branch-bフラグと一緒に使用して新しいブランチを作成します。

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'

テキストエディターで、変更する文書を開き、Markdownフォーマットを使用して変更を行います。

終了したら、変更を保存し、ターミナルを選択して Git のステータスを確認します。出力は以下のようになります。

```bash $ git status ブランチでのメタデータのタイプミスの修正について コミット用にステージングされていない変更: (「git add...」を使用してください。「」でコミットされる内容を更新する) (「git restore」を使用してください...「」を使用して作業ディレクトリの変更を破棄する) 変更済み:\_docs/_home/metadata.md

コミットに変更は加えられません (「git add」または「git commit-a」を使用) ```

git addどの変更をコミット用にステージングするかを Git に伝えるのに使います。次のコマンドは 2 つのオプションを表示します。

• パイプの左側:を使用して、--all変更したファイルをすべて追加します。
• パイプの右側:PATH_TO_FILE変更したファイルへの相対パスに置き換えて、個々のファイルを追加します。

1
git add {--all|PATH_TO_FILE}

git commit-mフラグを付けて使用すると、短い説明 (またはメッセージ) とともにコミットを作成できます。

1
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 recommended software 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'.

ターミナルで、「ローカルサーバーを起動する」rake コマンドを使用します。

1
2
cd ~/braze-docs
rake

出力は以下のようになります。

1
2
3
4
5
6
7
8
9
== Sinatra (v3.0.4) has taken the stage on 4000 for development with backup from Puma
Puma starting in single mode...
* Puma version: 6.3.1 (ruby 3.2.2-p225) ("Mugi No Toki Itaru")
*  Min threads: 8
*  Max threads: 32
*  Environment: development
*          PID: 16158
* Listening on http://127.0.0.1:4000
...

デフォルトでは、http://127.0.0.1:4000サイトプレビューはローカルホストで生成されます。サイトプレビューを開くには、Web ブラウザでリンクを開きます。

ローカルサーバーを停止するには、ターミナルを再度開き、Control+C を押します。

PRで、支店名の横にある [コピー] を選択します。

テキストエディタのターミナルで、ブランチをチェックアウトし、GitHub のリモートブランチから最新の更新を取得します。

1
git checkout BRANCH_NAME && git pull

BRANCH_NAMEクリップボードにコピーしたブランチ名に置き換えます。出力は以下のようになります。

1
2
3
$ git checkout fixing-typo-in-metadata  && git pull
Switched to branch 'fixing-typo-in-metadata'
Your branch is up to date with 'origin/fixing-typo-in-metadata'.

テキストエディターで、変更する文書を開き、手順 2 で行った手順を繰り返します。変更を加えてください。