Skip to content

Git and GitHub

Learn how to use Git and GitHub, so you can contribute to Braze Docs. Approved contributions will be deployed on the following Tuesday or Thursday. Be sure to check out Braze Docs so you can celebrate your hard work. Thanks for contributing!

Prerequisites

If you haven’t already, complete the steps for Contributing to Braze Docs.

Getting the latest changes

To update your local environment with the latest changes from the Braze Docs repository , pull the develop branch.

Creating a branch

To create a new branch, use Git’s checkout command with the -b flag.

Replace BRANCH_NAME with a short, non-space-separated description of your branch’s changes. Your output should be similar to the following:

Creating a pull request

To create a pull request (PR) for the branch you created previously, add your changes and stage a commit. Replace COMMIT_MESSAGE with a short sentence describing your changes.

Your output should be similar to the following:

Push your changes to the Braze Docs GitHub repository. Replace BRANCH_NAME with the name of your branch.

If you previously forked the Braze Docs repository, use upstream as your remote. External contributors typically fork the repository.

If you previously cloned the Braze Docs repository, use origin as your remote. Internal contributors typically clone the repository.

The output is similar to the following:

Go to the Braze Docs GitHub repository , then select Compare & pull request.

The Braze Docs GitHub repository showing "Open pull request".

In the PR description, you’ll see Markdown comments similar to the following. Use these comments to help fill out your PR.

When you’re finished, select the pull request dropdown, then select Draft pull request.

The Braze Docs GitHub repository showing "Draft pull request".

Allowing changes to pull requests

In GitHub, go to the PR you previously created, then check Allow edits and access to secrets from maintainers. This will let the Braze Docs team make style or formatting changes to your content.

A Pull Request showing the allow edits from maintainers checkbox.

Requesting a review

To request a PR review from a member of the Braze Docs team, go to the PR you previously created and select Ready for review.

An example pull request with the "Ready for review" button highlighted.

Select Reviewers, then type braze-inc/docs-team and select the team name. Press Esc or click out of the dropdown to confirm your selection.

An example pull request with "docs-team" added as the reviewer.

If the Braze Docs team requests additional changes after their review, you’ll be notified per your GitHub notification settings . If no changes are required, the team will approve and merge your changes.

Approved contributions will be deployed on the following Tuesday or Thursday. Be sure to check out Braze Docs so you can celebrate your hard work. Thanks for contributing!

HOW HELPFUL WAS THIS PAGE?
New Stuff!