O3DE Docs Contributions: Runbook

Quick Start: Runbook for O3DE Docs Contributions

#1Fork the O3DE docs repo to your personal GitHub account.A GitHub account is required. Sign up here .
#2Clone your fork of the O3DE docs repo to your local workstation.Make sure you remember the file path to the cloned repo on your local workstation. What’s “cloning”? Read our detailed Getting started with O3DE docs contributions guidance!
#3git remote add upstream upstream to the O3DE docs repo. origin is your remote fork. Ultimately, you will push your changes to origin, and then submit a pull request (PR) from your fork (origin) to the O3DE docs repo (upstream). Any subsequent pushes of changes to the branch you push will be reflected in the PR you made to from origin to upstream — you don’t need to create another PR from origin to upstream as long as the PR for your branch remains open.
#4git fetch upstreamThis updates local Git information about what is available from the upstream repo.
#5git switch -c development upstream/developmentSets your local development branch to track the upstream development branch as its remote repo. This ensures that your local development is always in sync with the latest changes to development after a git pull.
#6git switch -c your-new-branch-name-here upstream/developmentCreates a new working branch from development. Please give it a useful and easily understood name that indicates its scope and lifetime, such as style-guide-updates. As a best practice, create a new branch from development for every potential PR, and try to scope your work within that branch for easier community review.
#7Make your changes and confirm them locally.
#8Run git add for every file you’ve edited.Adds your files to local Git staging. You can use git add . to add every file you’ve edited, but be careful with this. Do not add any files that are not work you are submitting for review!
#9Use git status to verify the list of files to commit.Before you commit your changes, it’s a good idea to make sure you have not staged any changes that you did not intend to include in your PR. Use git restore --staged your-filename-here to remove a modified file from staging.
#10git commit -s -m "useful-commit-message-here"Writes your changes to the branch history in preparation for submission. The -s parameter will add a DCO signature of the form Signed-off-by: <>" to your commit, where and are the and, respectively, from your .gitconfig file. Your commit message should provide a clear assessment of the work you did.
#11git push originPushes your commit to your remote fork (origin).
#12To create a PR, use the URL that was part of the git push output, or go to your remote fork on GitHub and create a PR from your working branch into the development branch for O3DE docs repo .Make sure that the base in your PR targets the development branch of
Base branch is set to development in most PRs
#13Check out your new PR on the O3DE docs repo.Your PR will be auto-assigned reviewers. Keep a lookout for comments and requested change, and respond to them promptly so that the PR does not become “stale”. Someone from the O3DE community will merge your changes after all review suggestions have been addressed by you.