In this article we discuss the steps required for CRYENGINE V users to submit Pull Requests to Crytek via GitHub.
This article assumes that users already have:
- An account with GitHub
- Installed the GitHub Desktop for Windows application on their PC
- Read and understood the following: Crytek coding guidelines and Crytek commit description rules
The Crytek GitHub repository (repo) can be found here.
Email Address and Github
Ensure that the email address you use is associated with your Github account. Using a non-associated email account will cause failures in Pull Requests/submissions to Crytek.
CRYENGINE users must submit their pull requests to a branch named pullrequests in the Crytek GitHub repo. Any pull request that is submitted to any other Crytek branch will not be accepted by Crytek. Once a pull request is accepted it will be evaluated by Crytek, any comments made can be seen via GitHub and all submitters should monitor the channel to follow the progress being made in regard to their submission.
- Go to the Crytek GitHub repo (this is GitHub.com) and sign in. This will open the Crytek/CRYENGINE repo.
- Fork the Crytek repo by clicking on the icon. You maybe be asked "Where should we fork this repository?" In almost all cases this will be to the account that you have just signed in to. In the example(s) used below the account is named Cry-Doug and the name of the repo that will be/has been created is made up of the account name and CRYENGINE. Hence we will have a repo named Cry-Doug/CRYENGINE.
- We now need to clone a repo, so open the GitHub desktop application (use the icon on your PC desktop). This opens the following screen. Click the Clone a repository button, the screen in step 4 will open.
- You now need to enter the name of your repo (in the URL or username/repository field). In our exampe it will be Cry-Doug/CRYENGINE. You can also change the Local path as you so desire. In our case we have chosen the D Drive of our PC. NOTE: We strongly recommend that if you want to compile Engine code then you save your repo on an SSD. Finally, click the Clone button.
- We now have a cloned repo named Cry-Doug/CRYENGINE. This can be seen be navigating back to https://github.com/Cry-Doug/CRYENGINE
- Now navigate to the GitHub Desktop application. You now need to switch the Current branch from release (using the drop down menu) to origin/pullrequests. Changing to pullrequests is ESSENTIAL!!
- The next step is to create your own branch. So from the menu options, click Branch -> New branch..., give your Branch a name. In the example below we have named our branch Docs_Test. Finally, click the Create branch button.
- This will open the screen shown below.
- You now need to make your changes i.e. the ones that you want to submit to Crytek. This could be acheived with a variety of tools such as Notepad or VS etc. In our example we have just added the words CHANGE CHANGE CHANGE to the README.md file. This can file can be found (in our case on our D drive, see step 4 above).
- Once you have made your changes go back to the GitHub desktop application. You will see that GitHub Desktop automatically detects the change(s) that you have made (screenshot below).
- Ensure that any file(s) that you want to commit/submit to Crytek are ticked. Then add a summary. This is a requirement, whereas the description is optional. Finally, click the Commit button (in our case Commit to Docs_Test).
- We now need to publish the branch, so click the Publish branch button.
- We now need to get our branch to Crytek. Create a pull request using the menu option Branch -> create pull request (you may need to login to GitHub). This will open the window shown below.
- You MUST then change base: to pullrequests (use the drop down). Also ensure that the Title entered meets the Crytek commit rules.
- Finally, click the Create the pull request button. This will trigger the review process at Crytek's end.
- The submitter will be notified by email of any changes/updates made.