Submit a Pull Request

You can contribute to the Umbraco Documentation by submitting a Pull Request (PR). A PR is a way to suggest changes to an open-source project, such as fixing errors, improving readability, or adding new content.

There are two ways to create a PR:

1. Edit a file directly on GitHub.

2. Create a fork of the GitHub repository.

Option 1: Creating a PR directly on GitHub

You can submit a PR directly from our repository. You can also use the button on the right side of every article title. This allows you to jump straight into the file on GitHub and suggest your changes.

Following the approach is recommended for changes such as:

• Fixing typos or grammar mistakes.

• Changes that are confined to a single article.

• Updating code snippets.

1. Navigate to the article you want to edit.

2. Select "Edit on GitHub" from the right side of the article.

3. Select the 🖊️ icon to start editing the article.

4. Make the changes.

5. Add a commit message describing what you changed.

6. Select Propose changes.

7. Fill in the required information in the PR description.

8. Select Create pull request to submit the PR.

Option 2: Creating a PR through a Fork

The second option to submit a PR is by using a fork of the Umbraco Documentation repository. This method requires more initial setup but lets you reuse your fork for future contributions.

Following the approach is recommended for changes such as:

• Writing new articles or guides.

• Adding updates that affect multiple articles.

• Applying an update that needs to be added to multiple versions.

There are a lot of great tutorials available online on how to fork a repository (GitHub).

Step 1: Creating a Fork

1. Ensure Git is installed on your machine.

2. Go to the Umbraco Documentation repository.

3. Select Fork in the top-right corner to create a personal copy of the repository.

Once the fork is created:

1. Clone your fork to your local machine.

2. Make your changes in a local branch.

3. If you add a new article, update the SUMMARY.md file to include it in the documentation navigation.

4. Sync your changes back to your fork.

To sync via command line:

• Set the original repository (UmbracoDocs) as an upstream to sync from.

• Fetch the updates.

• Update your own fork.

git remote add upstream https://github.com/umbraco/UmbracoDocs/
git fetch upstream
git rebase upstream/main

To sync via GitHub:

• Use the Sync fork option when your fork is behind the original repository.

Step 2: Creating a PR

Once you have made changes and are happy with the result, you can create a PR.

1. Navigate to the Code section of your fork.

2. Select Contribute > Open pull request.

1. Add a title and description explaining your changes.

2. Select Create pull request to submit a PR to the original repository.

Step 3: The Review Process

Your PR will be reviewed by the documentation team at Umbraco HQ.

Review times can vary based on the size and complexity of the contribution—from a few minutes to several weeks.