Contributing to Braze Docs

Thanks for contributing to Braze Docs! Every Tuesday and Thursday, we merge community contributions and deploy them to Braze Docs. Use this guide to get your changes merged during our next deployment.

Prerequisites

Some understanding of Git is required to contribute to Braze Docs. If you’re new to Git and don’t know where to start, see Git Book: Getting Started. If you just need a refresher, see Git and GitHub.

Start contributing

Step 1: Create a GitHub account

If you don’t have a GitHub account, create one now. Otherwise, continue to the next step.

Step 2: Sign the CLA

Everyone that contributes to Braze Docs must sign the Contribution License Agreement (CLA). If you don’t sign the CLA, the @cla-bot on GitHub will automatically block your pull request.

Step 3: Fork the repository

Go to the Braze Docs GitHub repository, then select Fork.

Keep the default settings, then select Create fork.

Step 4: Choose how to contribute

You can contribute to Braze Docs using either of the following methods. Choose the one that’s best for you:

Method	Use Case	Additional Requirements
GitHub website	For small, single-document changes.	No additional requirements needed. With this method, you’re ready to start contributing!
Local environment	For complex or multi-document changes.	Before you can use this method, you’ll need to set up your local environment.

Next steps

If you’re new to Git or docs-as-code, start with our tutorial: Your first contribution. Otherwise, check out one of the following.

• Content management
• YAML metadata
• Generating a preview
• Style guides