O3DE Code Contribution GitHub Workflow

Looking to submit new or changed code to Open 3D Engine (O3DE)? Exciting! Follow the guidance below to submit your first PR.

GitHub Code Contribution Workflow

The O3DE base repository is on GitHub at https://github.com/o3de/o3de .

GitHub code contribution workflow diagram

At a high level, the workflow is:

  1. Create a branch from the local clone of your fork, do your work, push it to your fork (origin), and submit a pull request from your fork to the O3DE GitHub repo (upstream).

  2. Your pull request is checked for merge conflicts. If one is found, the pull request is rejected.

  3. If there are no merge conflicts, automated review (AR) is triggered and the pull request is flagged for code review.

  4. If the pull requests passes code review, the SIG owner (or a delegate) will merge it into the main branch of the O3DE GitHub repo.

Initial Git contribution workflow steps

  1. Create a fork of https://github.com/o3de/o3de.git into your own GitHub account. To do this, go to the O3DE public GitHub repo at https://github.com/o3de/o3de and create a fork by selecting the “Fork” button in the upper-right. This will clone the O3DE public repo into your repo, and may take a few minutes. The URL for your fork will be something like https://github.com/<YOUR GITHUB NAME HERE>/o3de.git.

  2. Now, clone your fork locally by opening GitBash (or a Git-enabled shell or utility). Change directories to the folder you want to clone the repo in and run: git clone https://github.com/<YOUR GITHUB NAME HERE>/o3de.git. You will now have the clone of your fork on your local desktop and can work with the files directly.

  3. However, to simplify this workflow, you must make some changes to your local Git configuration. In this case, you will be setting your fork’s URL as the origin repo, and the O3DE public repo as your upstream repo, and updating the LFS URL. Run the following Git commands from your locally cloned fork’s path:

    git remote add upstream https://github.com/o3de/o3de.git
    

    Confirm that upstream points to the O3DE public repo and that origin points to your fork:

    git remote -v
    

    Minimally, you should see output that looks like this:

    origin  https://github.com/<FORK>/o3de.git (fetch)
    origin  https://github.com/<FORK>/o3de.git (push)
    upstream  https://github.com/o3de/o3de.git (fetch)
    upstream  https://github.com/o3de/o3de.git (push)
    

    You can also configure upstream to target specific branches, as well.

    Update the LFS URL to include your fork. This will enable you to push changes to large files. Open the .lfsconfig file at the root of the repository for complete instructions and the DISTRIBUTION to use.

    git config lfs.url https://<DISTRIBUTION>.cloudfront.net/api/v1/fork/<FORK> 
    

    You may be prompted to re-authenticate the next time you pull or push. Remember to use your GitHub personal access token not your GitHub password.

    If you need to revert this change later you can run the following command:

    git config --unset lfs.url 
    
  4. Now, update your local repo by git fetching the branches currently active on the O3DE repo. You can get all working branches with git fetch upstream --all, or fetch a specific branch with git fetch upstream <name-of-branch>.

  5. Rebase the commit history to the last commit from the upstream main branch:

    git rebase upstream/main
    
  6. Check out the branch you will be working on and take your own branch from it to perform your work.

    git checkout <name-of-fetched-branch>
    

    Confirm you have switched branches successfully with git branch. If you are on the branch you want, create your own branch from it:

    git checkout -b <name-of-your-working-branch>
    

Ongoing Git workflow steps

Now, you’re ready to do some work! After you’ve made some changes and saved your work, it’s time to submit it as a pull request (PR) for review.

  1. First, stage (add) the new or modified code files, commit your changes, and submit a pull request to your fork (origin) with the following commands. (Check which branch you are on with git branch first!):

    git add .
    git commit -s -m "<commmit_message>"
    git push -u origin <your-branch-name>
    

    This will push the update to your fork, and NOT the O3DE code repo.

    Note:
    We require DCO signing on all code commits. This requires that you have both your contributor name and email address in your .gitconfig file, or have previously run the following Git commands from a Git-enabled shell: git config user.name "YOUR CONTRIBUTOR NAME HERE" git config user.email "YOUR CONTRIBUTOR CONTACT MAIL HERE". (This command updates your .gitconfig.) You must use the -s option on every commit. If you are using a Git-enabled IDE, such as Visual Studio 2019 or Visual Studio Code, turn on commit signing in the preferences.
  2. (Optional): Test your branch with Jenkins.

    The source for the code build pipeline and the required infrastructure is stored in the O3DE repo. Contributors can utilize this to spin up their own build/test pipeline or they can test locally.

    The Jenkinsfile (AutomatedReview/Jenkinsfile) is the source for the Automated Review (AR)/Jenkins Pipeline used by O3DE. Refer to Simulate an automated review run in the user guide for more information on how to run a test locally.

    The scripts to install all the dependencies on the build nodes and other infrastructure setup scripts are also stored in the repo for contributors and customers to use.

  3. Submit a pull request from your fork to the O3DE code repo.

    • Navigate to your fork repo in GitHub, click the Pull Requests tab and click New Pull Request.
    • On the Compare page, verify the base repo and branch point is set to O3DE/main. (This should be set by default.)
    • In the head drop down menu, select your fork repo and branch, and then select Create Pull Request.

    Creating a pull request from your fork to o3de/main.

    • Add a title and description for your pull request. Provide a clear scope of your changes in as few words as you can.
    • Add reviewers (Note: Required reviewers and other PR requirements will be finalized in a CONTRIBUTING.md file).

    Adding reviewers to an O3DE pull request.

    • Now, select Create pull request!
  4. The SIG owner (or a delegate) for the affected component reviews the pull request. At the same time, the automated review (AR) is triggered.

    Note:
    The SIG owner will review the pull request and must approve the AR run before it can start. This is to required to prevent the pipeline from running malicious code. The AR build that is triggered on pull requests runs on the infrastructure owned by O3DE.
  5. Once all review comments have been addressed, a SIG member will approve the pull request.

    The pull request receives the required approvals from SIG and the AR passes.

    An O3DE contribution pull request in a green approved state.

    The SIG owner (or a delegate) can then merge your pull request into o3de/main, and you’re done! Nice!

Reviews and feedback on pull requests

The SIG owner can request changes by providing feedback. You should engage with the comments and make any valid corrections or updates to your code contribution on the same branch. If the automated review (AR) fails, review the errors, make any necessary fixes, and update the pull request on the same branch.

An example of a failed AR check in a pull request.

If you do not make the changes to pass the AR, or ignore the code review feedback, the SIG owner may reject the changes in the pull request by marking it closed.


Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.