# Submit a contribution

This page walks through submitting a docs change as a pull request, from forking the repository to getting your change merged.
Both Flyte community members and Union customers are welcome to contribute.

Before you start, [set up a local docs dev environment](https://www.union.ai/docs/v2/union/community/contributing-docs/submitting-contributions/quick-start) so you can preview your changes.

## Target the right branch

The docs repository keeps each version of the site on its own long-lived branch:

* **For Flyte or Union 2.x**, branch off `main` and open your pull request against `main`.
* **For Flyte or Union 1.x**, branch off `v1` and open your pull request against `v1`.

Most contributions target `main` (v2). See [Versions](https://www.union.ai/docs/v2/union/community/contributing-docs/submitting-contributions/versions) for how versions map to branches.

## Fork and clone

If you have write access to the repository, you can branch directly. Otherwise, fork it first:

1. Fork [`unionai/unionai-docs`](https://github.com/unionai/unionai-docs) to your own GitHub account.
2. Clone your fork and initialize the submodules as described in [Set up a local docs dev environment](https://www.union.ai/docs/v2/union/community/contributing-docs/submitting-contributions/quick-start):

   ```bash
   git clone https://github.com/<your-username>/unionai-docs.git
   cd unionai-docs
   make init-infra
   make init-examples
   ```

## Create a feature branch

Create a branch off the branch you are targeting (usually `main`):

```bash
git checkout main
git pull
git checkout -b my-docs-change
```

Give the branch a short, descriptive name.

## Make and preview your changes

Edit the Markdown files under `content/` and preview them locally with the live server:

```bash
make dev
```

See [Author content](https://www.union.ai/docs/v2/union/community/contributing-docs/submitting-contributions/authoring) for how to write pages, and the [writing guidelines](https://www.union.ai/docs/v2/union/community/contributing-docs/submitting-contributions/writing-guidelines) for the editorial conventions the site follows.

## Commit with a sign-off

Sign off each commit with the `-s` flag. This adds a `Signed-off-by` line that records that you agree your contribution can be included in the project:

```bash
git add content/...
git commit -s -m "Describe your change"
```

If you have several commits, sign off each of them.

## Open a pull request

Push your branch and open a pull request against the correct base branch (usually `main`):

```bash
git push -u origin my-docs-change
```

Then open the pull request on GitHub. In the description, explain what you changed and why.
If your change targets v1, make sure the base branch is `v1`.

## Check the preview build

Every pull request produces a preview build of the site on Cloudflare.
Look for the preview link in the pull request checks and open it to confirm your changes render as you expect, in the affected variants.

## Review and merge

A maintainer reviews your pull request.
Continuous integration checks run automatically (for example, link and image validation).
Address any review feedback or failing checks by pushing more commits to the same branch.
Once the pull request is approved and all checks pass, a maintainer merges it, and your change goes live on the next production deploy.

---
**Source**: https://github.com/unionai/unionai-docs/blob/main/content/community/contributing-docs/submitting-contributions.md
**HTML**: https://www.union.ai/docs/v2/union/community/contributing-docs/submitting-contributions/